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

Adding issue management workflows #3090

Merged
merged 1 commit into from Mar 14, 2024

Conversation

krmahadevan
Copy link
Member

@krmahadevan krmahadevan commented Mar 14, 2024

We can now add the below labels to issues
And the workflow will automatically add the required text that will be instructions to the issue submitter.

  • needs-sample
  • question
  • help-wanted

These labels should be added to the repository
And we can perhaps get rid of the other labels
that intend to convey the same thing.

More details available at: https://github.com/peaceiris/actions-label-commenter

Summary by CodeRabbit

  • New Features
    • Introduced a Label Commenter tool to automatically add specific comments to issues based on their labels, enhancing communication on issues labeled as needing more information, questions, and help-wanted.

Copy link

coderabbitai bot commented Mar 14, 2024

Warning

Rate Limit Exceeded

@krmahadevan has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 50 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 3308b3c and 40c703b.

Walkthrough

This update introduces a new tool called Label Commenter and its accompanying GitHub Actions workflow. The tool is designed to automatically post comments on issues based on the labels applied to them, streamlining communication for issues labeled as needing more information, questions, and help-wanted. This automation enhances issue management and response efficiency within the project's GitHub repository.

Changes

Files Change Summary
.github/label-commenter-config.yml
.github/workflows/label-commenter.yml
Introduced Label Commenter tool configuration and workflow for commenting on labeled issues.

🐰✨
In the land of code and git,
Where issues pile and keyboards click,
A rabbit hopped, with wisdom shared,
"Label Commenter's here, no issue spared!"
🌟 With every tag, it leaps and bounds,
In GitHub's garden, its work astounds.
"Fear not," it whispers, "for I am here,
To comment and guide, and bring you cheer!"
🐰✨

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-tests 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3308b3c and cb017bf.
Files selected for processing (2)
  • .github/label-commenter-config.yml (1 hunks)
  • .github/workflows/label-commenter.yml (1 hunks)
Additional comments: 4
.github/workflows/label-commenter.yml (1)
  • 1-18: The workflow is well-structured and follows best practices for GitHub Actions, including specifying trigger events, permissions, and conditions for running the job. It's good to see the use of a specific runner version (ubuntu-20.04) for consistency and the condition to ensure the workflow runs only for the 'testng-team' repository owner.
.github/label-commenter-config.yml (3)
  • 3-20: The message for the needs-sample label is well-crafted, providing clear instructions and a comprehensive list of details needed from the issue submitter. It encourages sharing a Minimal, Reproducible Example and specific project details, which is crucial for reproducing and resolving issues efficiently.
  • 21-28: The message for the question label effectively directs users to external platforms for asking questions, keeping the issue tracker focused on bugs and feature requests. The action to close the issue after labeling is appropriate and helps maintain a clean issue tracker.
  • 29-35: The message for the help-wanted label is concise and effectively encourages community contributions by inviting interested contributors to comment. This is a positive way to engage the community and solicit help on issues.

Copy link
Member

@juherr juherr left a comment

Choose a reason for hiding this comment

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

Good idea 👍

.github/workflows/label-commenter.yml Outdated Show resolved Hide resolved
We can now add the below labels to issues 
And the workflow will automatically add the required
text that will be instructions to the issue submitter.

* `needs-sample`
* `question` 
* `help-wanted`

These labels should be added to the repository 
And we can perhaps get rid of the other labels
that intend to convey the same thing.

More details available at: https://github.com/peaceiris/actions-label-commenter
@krmahadevan
Copy link
Member Author

Good idea 👍

I saw this being used in selenium ( I commit there as well) and found it to be useful. So decided to borrow it from there 😁

@juherr juherr merged commit 19cd580 into testng-team:master Mar 14, 2024
7 of 9 checks passed
@krmahadevan krmahadevan deleted the add_github_workflows branch March 14, 2024 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants