Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: Add GitHub Action for go mod tidy and mocks #20501

Merged
merged 4 commits into from
May 31, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented May 31, 2024

Adds a new GitHub Action workflow to ensure code consistency across pull requests.

  • Introduces a new workflow file .github/workflows/pr-go-mod-tidy-mocks.yml that triggers on pull requests to the main branch.
  • Configures concurrency to run this workflow in parallel with other CI jobs, with a unique group identifier and cancellation of in-progress runs.
  • Defines two jobs within the workflow:
    • The first job, go-mod-tidy, checks out the code, sets up Go, runs ./scripts/go-mod-tidy-all.sh, and fails if there are any diffs, indicating the need for the contributor to run the script and commit changes.
    • The second job, generate-mocks, follows a similar pattern for generating mocks with make mocks and fails if there are uncommitted changes resulting from the command.

For more details, open the Copilot Workspace session.

Summary by CodeRabbit

  • Chores
    • Introduced a new GitHub Actions workflow to ensure dependencies are tidy and generate mocks for testing on pull requests to the main branch.

@julienrbrt julienrbrt requested a review from a team as a code owner May 31, 2024 08:52
Copy link
Contributor

coderabbitai bot commented May 31, 2024

Warning

Rate limit exceeded

@julienrbrt has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 43 minutes and 33 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 7bed202 and d917f65.

Walkthrough

The new GitHub Actions workflow, named 'PR Go Mod Tidy and Mocks', is designed to run on pull requests to the main branch. It consists of two jobs: 'Check go mod tidy' and 'Generate Mocks'. This workflow ensures that the project's dependencies are tidy and that mocks for testing purposes are generated, maintaining code quality and consistency.

Changes

File Path Change Summary
.github/workflows/pr-go-mod-tidy-mocks.yml Introduces a GitHub Actions workflow to check go mod tidy and generate mocks on pull requests to the main branch.

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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b13e5cb and 7bed202.

Files selected for processing (1)
  • .github/workflows/pr-go-mod-tidy-mocks.yml (1 hunks)

.github/workflows/pr-go-mod-tidy-mocks.yml Outdated Show resolved Hide resolved
.github/workflows/pr-go-mod-tidy-mocks.yml Outdated Show resolved Hide resolved
@julienrbrt
Copy link
Member Author

Once this is merged, we can make this job required.

@julienrbrt julienrbrt added this pull request to the merge queue May 31, 2024
Merged via the queue into main with commit 8364791 May 31, 2024
64 of 65 checks passed
@julienrbrt julienrbrt deleted the julienrbrt/add-go-mod-tidy-mocks-action branch May 31, 2024 10:00
alpe added a commit that referenced this pull request May 31, 2024
* main: (120 commits)
  chore: update protoc-gen-swagger to protoc-gen-openapiv2 (#20448)
  ci: Add GitHub Action for go mod tidy and mocks (#20501)
  chore: Address linter issues (#20486)
  fix: wrap errors in auto CLI service registration (#20493)
  chore: fix comment (#20498)
  chore: fix the note box syntax error (#20499)
  feat(server/v2): introduce cometbft v2 (#20483)
  refactor(x/upgrade): migrate to appmodule.VersionMap (#20485)
  docs: code guidelines changes (#20482)
  feat(cosmovisor): load cosmovisor configuration from toml file (#19995)
  perf(math): Significantly speedup Dec quo truncate and quo Roundup (#20034)
  fix: Bump CometBFT versions (#20481)
  refactor(core): remove redundant ExecMode (#20322)
  feat(store/v2): pruning manager (#20430)
  chore: force reload sonar cloud  (#20480)
  refactor(x/accounts): reuse calculated sum in `func safeAdd` (#20458)
  refactor: remove `defer` in loop (#20223)
  ci: remove livness test (#20474)
  build(deps): Bump bufbuild/buf-setup-action from 1.32.1 to 1.32.2 (#20477)
  chore: migrate a few diagrams to mermaid (#20473)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants