Skip to content

Add labels with a new GitHub Action#199

Merged
5ouma merged 1 commit intomainfrom
ci-pr-label-commit
Mar 23, 2025
Merged

Add labels with a new GitHub Action#199
5ouma merged 1 commit intomainfrom
ci-pr-label-commit

Conversation

@5ouma
Copy link
Owner

@5ouma 5ouma commented Mar 23, 2025

⚠️ Issue

close #


✏️ Description

Follow the Conventional Commit and auto-add with commits.

@5ouma
ci(pr): Add labels with a new GitHub Action
0954d94 
Follow the Conventional Commit and auto-add with commits.
Copilot AI review requested due to automatic review settings March 23, 2025 11:30
@coderabbitai
Copy link

coderabbitai bot commented Mar 23, 2025 •
edited
Loading

Walkthrough

The pull request streamlines the pull request template by removing multiple categorization checkboxes and replacing them with a single Code of Conduct agreement checkbox. It also updates the repository’s labeling system by introducing new configuration files and workflows while removing an obsolete PR labeler. Additionally, the changelog configuration in the release file has been modified with updated category entries and label adjustments.

Changes

File(s) Change Summary
.github/PULL_REQUEST_TEMPLATE.md Removed the "Type of the Change" section with multiple checkboxes and replaced it with a single "I agree to follow the [Code of Conduct]" checkbox, with the Code of Conduct link reformatted as a reference.
.github/labeler.yml, .github/pr-labeler.yml, .github/workflows/labeler.yml Added a new label configuration file with commit message matchers and a workflow for automated PR labeling; removed the previous PR labeler configuration file.
.github/release.yml Updated the changelog configuration by adding an exclusion label ("◀️ Revert"), removing the "🛡️ Security Fixes" entry, adding "🎨 Style Updates", reinstating "🏎️ Performance Improvements", renaming "🔧 Maintenance" to "🔨 Build Updates", and simplifying the dependencies labels.
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4f11f2b and 0954d94.

📒 Files selected for processing (5)
  • .github/PULL_REQUEST_TEMPLATE.md (1 hunks)
  • .github/labeler.yml (1 hunks)
  • .github/pr-labeler.yml (0 hunks)
  • .github/release.yml (2 hunks)
  • .github/workflows/labeler.yml (1 hunks)
💤 Files with no reviewable changes (1)
  • .github/pr-labeler.yml
🔇 Additional comments (9)
.github/release.yml (6)

4-4: New Exclusion Label Added
The addition of the "◀️ Revert" label to the exclusion list is clear and aligns with the strategy to ignore revert commits in changelog generation. Please verify that this label is consistently applied in other related configurations if needed.

17-18: Addition of "Style Updates" Category
The new "🎨 Style Updates" category has been introduced nicely. Ensure that commit messages pertaining to style changes follow the pattern defined in the labeler configuration.

21-22: Reinstated Performance Improvements Category
The reinstatement of the "🏎️ Performance Improvements" category is appropriate. Confirm that the label "🏎️ Performance" used here matches exactly with what is defined in the labeler settings to avoid any mismatches.

25-26: Introduction of "Build Updates" Category
The new "🔨 Build Updates" category is a good addition to clearly delineate build-related changes. It would be beneficial to double-check that any build-related commits are tagged correctly according to this new category.

29-30: Reinstated "Maintenance" Category
Reintroducing the "🔧 Maintenance" category improves the granularity of change tracking. Please ensure that its application in commits and changelog generation remains consistent with this update.

31-32: Simplified Dependency Updates Label
Changing the dependency updates label to "[⛓️ Dependencies]" enhances clarity. Verify that this simplified label is updated across any related documentation or automation scripts.

.github/workflows/labeler.yml (1)

1-17: Labeler Workflow Implementation
The new GitHub Actions workflow for labeling pull requests is implemented well. Using the explicit commit hash for the fuxingloh/multi-labeler action (v4.0.0) ensures reproducibility and stability. The configuration for permissions is correctly scoped to allow writing to pull-requests.

.github/PULL_REQUEST_TEMPLATE.md (1)

19-21: Streamlined Pull Request Template
The removal of the detailed "Type of the Change" section and replacement with a single "I agree to follow the [Code of Conduct]" checkbox significantly simplifies the PR template. The reference-style link to the Code of Conduct is correctly formatted.

.github/labeler.yml (1)

1-40: New Labeler Configuration File
The new .github/labeler.yml file defines a comprehensive set of labels with corresponding matchers using regular expressions conforming to Conventional Commit standards. Each label—including the new "◀️ Revert" entry—is clearly specified, and the regex patterns appear to be well thought out.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this 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.

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.

@github-actions github-actions bot added the 🎽 CI Changes to CI configuration files and scripts label Mar 23, 2025
Copilot AI reviewed Mar 23, 2025
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds automated label assignment using a new GitHub Action based on conventional commit messages. Key changes include:

  • Introducing a new label configuration file (.github/labeler.yml) with regex patterns for commit messages.
  • Adding a GitHub workflow (.github/workflows/labeler.yml) to automatically label pull requests.
  • Updating the PR template and release configuration to streamline contributor guidelines and changelog generation.

Reviewed Changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated no comments.

File Description
.github/labeler.yml Adds a YAML configuration mapping commit types to issue labels.
.github/workflows/labeler.yml Introduces an action to automatically apply labels to pull requests.
.github/PULL_REQUEST_TEMPLATE.md Simplifies PR template by updating checkboxes and Code of Conduct link.
.github/release.yml Adjusts changelog sections and updates label exclusions.
Files not reviewed (1)
  • .github/pr-labeler.yml: Language not supported
Comments suppressed due to low confidence (1)

.github/workflows/labeler.yml:12

  • [nitpick] Consider using 'ubuntu-latest' in lowercase for consistency with GitHub's recommended runner labels.
runs-on: Ubuntu-Latest

@5ouma 5ouma merged commit cce9833 into main Mar 23, 2025
8 checks passed
@5ouma 5ouma deleted the ci-pr-label-commit branch March 23, 2025 11:35
@github-actions github-actions bot mentioned this pull request Mar 23, 2025
Merged
@github-actions github-actions bot mentioned this pull request May 8, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees

@5ouma 5ouma

Labels

🎽 CI Changes to CI configuration files and scripts

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@5ouma