search

cosmos / cosmos-sdk

:chains: A Framework for Building High Value Public Blockchains :sparkles:
https://cosmos.network/
Apache License 2.0
6.28k stars 3.64k forks source link

ci: checkout with app-token (dependabot-update-all) #22612

Closed auricom closed 6 hours ago

auricom commented 4 days ago

Description

22563 - Tries to fix Tests / Code coverage not running on commits done by Dependabot Update All Go Modules workflow.

As it seems that PRBOT_PAT is not working anymore with https://github.com/cosmos/cosmos-sdk/pull/22545 ; this method is generating token on-the-fly using cosmos-renovate-app GithubApp.

image

:warning: This app must be configured on the cosmos/cosmos-sdk before this PR to be merged.

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.

I have...

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

Summary by CodeRabbit

coderabbitai[bot] commented 4 days ago
📝 Walkthrough ## Walkthrough The pull request modifies the workflow file `.github/workflows/dependabot-update-all.yml` by adding a new step to generate a GitHub App token. This step uses the `actions/create-github-app-token` action, which is executed before the checkout step. The token is generated using the `APP_ID` and `APP_PRIVATE_KEY` from the repository secrets, enabling Dependabot to securely access the repository during the workflow. ## Changes | File Path | Change Summary | |------------------------------------------------|---------------------------------------------------------------------------------------------------| | `.github/workflows/dependabot-update-all.yml` | Added a step to generate a GitHub App token using `actions/create-github-app-token` before checkout. | ## Possibly related PRs - #22547: This PR modifies the same workflow file `.github/workflows/dependabot-update-all.yml` and adds permission settings related to the GITHUB_TOKEN, which is relevant to the changes made in the main PR regarding the workflow's authentication process. ## Suggested labels `Type: CI` ## Suggested reviewers - tac0turtle - julienrbrt - akhilkumarpilli
📜 Recent review details **Configuration used: .coderabbit.yml** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between f74a9f63a8a206f7e9439a3744e7a45f361c5685 and bf597738641d074616cd0f655cbbf4837bbf355e.
📒 Files selected for processing (1) * `.github/workflows/dependabot-update-all.yml` (1 hunks)
🔇 Additional comments (3)
.github/workflows/dependabot-update-all.yml (3) `26-26`: **LGTM: Token usage in checkout step is secure** The generated token is correctly passed to the checkout step using the outputs context from the token generation step. --- `16-21`: **Verify the GitHub App token generation setup** The implementation looks correct, but there are a few important points to verify: 1. Ensure that the `cosmos-renovate-app` has been properly configured in the `cosmos/cosmos-sdk` repository 2. Verify that the required secrets (`APP_ID` and `APP_PRIVATE_KEY`) are properly set in the repository settings --- Line range hint `8-11`: **Consider adding error handling for PR title parsing** The workflow relies heavily on parsing the PR title in the `Extract updated dependency` step. Consider adding error handling or validation to ensure the PR title follows the expected format to prevent potential workflow failures.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.