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

chore: add auto labeler workflow #758

Merged
merged 4 commits into from
Aug 28, 2024

Conversation

hexqi
Copy link
Collaborator

@hexqi hexqi commented Aug 26, 2024

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

Background and solution

添加workflow:提交PR或者修改标题后自动添加/更新 label
自动添加的label包括:

  • enhancement:标题以feat: 开头
  • document: 标题以docs: 开头
  • bug: 标题以fix:开头
  • refactor-main: 目标分支为refactor/develop
  • ospp-2024: 目标分支为 ospp-2024/*

What is the current behavior?

验证:
image

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Introduced an automated labeling system for pull requests based on commit message patterns, enhancing project management.
    • Added a GitHub Actions workflow to automatically apply labels when pull requests are opened or edited, improving organization.
  • Documentation

    • Configured labels for enhancements, documentation, bugs, and specific projects, streamlining the contribution process.

Copy link
Contributor

coderabbitai bot commented Aug 26, 2024

Walkthrough

The changes introduce a new GitHub auto-labeler configuration and a workflow for automating the labeling of pull requests based on commit message patterns. The auto-labeler configuration defines labels for enhancements, documentation, bugs, and a specific project label, while the workflow automates the application of these labels during pull request events, streamlining project management.

Changes

Files Change Summary
.github/auto-labeler.yml Added a structured labeling system based on commit message patterns, defining labels and their matchers.
.github/workflows/auto-labeler.yml Introduced a GitHub Actions workflow for automatically labeling pull requests based on the new configuration.

Poem

🐇 In the garden, labels bloom,
With each pull request, there’s room,
Bugs and features, all in line,
Documented, oh how they shine!
A hop, a skip, the code’s in flow,
Auto-label magic, watch it grow! 🌼


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

@hexqi hexqi changed the title chore: add auto labeler workflow feat: add auto labeler workflow Aug 26, 2024
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bf68247 and 0572eaa.

Files selected for processing (2)
  • .github/auto-labeler.yml (1 hunks)
  • .github/workflows/auto-labeler.yml (1 hunks)
Additional context used
actionlint
.github/workflows/auto-labeler.yml

11-11: the runner of "actions/checkout@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

Additional comments not posted (5)
.github/auto-labeler.yml (4)

3-7: LGTM!

The enhancement label is correctly configured to match titles starting with feat:.

The code changes are approved.


8-11: LGTM!

The document label is correctly configured to match titles starting with docs:.

The code changes are approved.


12-15: LGTM!

The bug label is correctly configured to match titles starting with fix:.

The code changes are approved.


16-19: LGTM!

The ospp-2024 label is correctly configured to match base branches starting with ospp-2024/.

The code changes are approved.

.github/workflows/auto-labeler.yml (1)

3-5: LGTM!

The workflow trigger is correctly configured to run on pull request events (opened, edited).

The code changes are approved.

.github/workflows/auto-labeler.yml Outdated Show resolved Hide resolved
@hexqi hexqi marked this pull request as draft August 26, 2024 12:48
@hexqi hexqi changed the title feat: add auto labeler workflow feat: add auto labeler workflow Aug 26, 2024
@hexqi hexqi changed the title feat: add auto labeler workflow feat: add auto labeler workflow Aug 26, 2024
@hexqi hexqi changed the title feat: add auto labeler workflow feat: add auto labeler workflow Aug 26, 2024
@hexqi hexqi changed the title feat: add auto labeler workflow chore: add auto labeler workflow Aug 27, 2024
@hexqi hexqi marked this pull request as ready for review August 27, 2024 04:15
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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0572eaa and d1a374a.

Files selected for processing (2)
  • .github/auto-labeler.yml (1 hunks)
  • .github/workflows/auto-labeler.yml (1 hunks)
Files skipped from review due to trivial changes (1)
  • .github/auto-labeler.yml
Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/auto-labeler.yml

.github/workflows/auto-labeler.yml Outdated Show resolved Hide resolved
.github/workflows/auto-labeler.yml Outdated Show resolved Hide resolved
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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d1a374a and ce94958.

Files selected for processing (1)
  • .github/workflows/auto-labeler.yml (1 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/auto-labeler.yml

Copy link
Collaborator

@rhlin rhlin left a comment

Choose a reason for hiding this comment

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

good good

@chilingling chilingling merged commit ab783d8 into opentiny:refactor/develop Aug 28, 2024
1 check passed
hexqi added a commit that referenced this pull request Aug 28, 2024
* chore: add auto labeler workflow
添加workflow:提交PR或者修改标题后自动添加/更新 label
自动添加的label包括:
enhancement:标题以feat: 开头
document: 标题以docs: 开头
bug: 标题以fix:开头
refactor-main: 目标分支为refactor/develop
ospp-2024: 目标分支为 ospp-2024/*
hexqi added a commit that referenced this pull request Aug 28, 2024
* chore: add auto labeler workflow
添加workflow:提交PR或者修改标题后自动添加/更新 label
自动添加的label包括:
enhancement:标题以feat: 开头
document: 标题以docs: 开头
bug: 标题以fix:开头
refactor-main: 目标分支为refactor/develop
ospp-2024: 目标分支为 ospp-2024/*
hexqi added a commit that referenced this pull request Aug 28, 2024
* chore: add auto labeler workflow
添加workflow:提交PR或者修改标题后自动添加/更新 label
自动添加的label包括:
enhancement:标题以feat: 开头
document: 标题以docs: 开头
bug: 标题以fix:开头
refactor-main: 目标分支为refactor/develop
ospp-2024: 目标分支为 ospp-2024/*
hexqi added a commit that referenced this pull request Aug 28, 2024
* chore: add auto labeler workflow
添加workflow:提交PR或者修改标题后自动添加/更新 label
自动添加的label包括:
enhancement:标题以feat: 开头
document: 标题以docs: 开头
bug: 标题以fix:开头
refactor-main: 目标分支为refactor/develop
ospp-2024: 目标分支为 ospp-2024/*
hexqi added a commit that referenced this pull request Aug 28, 2024
* chore: add auto labeler workflow
添加workflow:提交PR或者修改标题后自动添加/更新 label
自动添加的label包括:
enhancement:标题以feat: 开头
document: 标题以docs: 开头
bug: 标题以fix:开头
refactor-main: 目标分支为refactor/develop
ospp-2024: 目标分支为 ospp-2024/*
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.

3 participants