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 auto assign job #21939

Merged
merged 7 commits into from
Sep 26, 2024
Merged

ci: add auto assign job #21939

merged 7 commits into from
Sep 26, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Sep 26, 2024

Description

Closes: #XXXX


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...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

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...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features
    • Introduced an automated workflow for assigning reviewers to pull requests, streamlining the review process.

Copy link
Contributor

coderabbitai bot commented Sep 26, 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 12 minutes and 17 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 fbb44e2 and 4a08aae.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

A new GitHub Actions workflow named auto-assign-prs.yml has been created to automate the assignment of reviewers to pull requests. This workflow is triggered by pull request events, such as when a pull request is opened or edited. It includes steps to check out the repository and assign requested reviewers as assignees using the GitHub API.

Changes

File Change Summary
.github/workflows/auto-assign-prs.yml New workflow added to automate reviewer assignment.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub
    participant Workflow

    User->>GitHub: Open or edit pull request
    GitHub->>Workflow: Trigger workflow
    Workflow->>GitHub: Checkout repository
    Workflow->>GitHub: Retrieve requested reviewers
    Workflow->>GitHub: Assign reviewers as assignees
Loading

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>, 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 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: 1

🧹 Outside diff range and nitpick comments (1)
.github/workflows/auto-assign-prs.yml (1)

1-30: Overall, the workflow is well-designed with room for minor improvements.

The "Auto Assign Reviewers" workflow is well-structured and achieves its intended purpose. It correctly triggers on relevant pull request events and uses appropriate actions for repository checkout and GitHub API interactions. The main area for improvement is in the script logic for assigning reviewers, where adding error handling and input validation would enhance robustness.

Consider adding a configuration file (e.g., .github/auto-assign-config.yml) to make the workflow more flexible. This could allow for customization of assignee selection logic, such as team-based assignments or rotation schedules, without modifying the workflow file itself.

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between dc2cea5 and fbb44e2.

📒 Files selected for processing (1)
  • .github/workflows/auto-assign-prs.yml (1 hunks)
🔇 Additional comments (3)
.github/workflows/auto-assign-prs.yml (3)

1-5: LGTM: Workflow name and trigger are well-defined.

The workflow name "Auto Assign Reviewers" accurately describes its purpose. The trigger events (pull request opened or edited) are appropriate for the intended functionality of assigning reviewers.


7-9: LGTM: Job configuration is appropriate.

The job name "assign-reviewers" is clear and descriptive. Using the latest Ubuntu runner (ubuntu-latest) is a good practice for staying up-to-date with security patches and features.


12-13: LGTM: Repository checkout step is correctly implemented.

The use of actions/checkout@v4 is appropriate for accessing the repository contents. Using the latest stable version (v4) ensures you have the most up-to-date features and security fixes.

.github/workflows/auto-assign-prs.yml Outdated Show resolved Hide resolved
@julienrbrt julienrbrt marked this pull request as draft September 26, 2024 19:32
@julienrbrt julienrbrt marked this pull request as ready for review September 26, 2024 19:42
@julienrbrt
Copy link
Member Author

Cool, so it doesn't removes assignees if reviewers are removed, but I think it is fine.

@julienrbrt julienrbrt requested review from auricom and removed request for hieuvubk September 26, 2024 19:46
name: Auto Assign Reviewers

on:
pull_request:
Copy link
Member Author

Choose a reason for hiding this comment

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

This won't work for external reviewers, but that's fine, I'll go assign reviewers manually like we do now.
This will already help daily.

@julienrbrt julienrbrt added this pull request to the merge queue Sep 26, 2024
Merged via the queue into main with commit 2c85694 Sep 26, 2024
72 checks passed
@julienrbrt julienrbrt deleted the julien/autoassign branch September 26, 2024 20:15
@coderabbitai coderabbitai bot mentioned this pull request Nov 8, 2024
12 tasks
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.

6 participants