Skip to content

PR Labeling workflow #83

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Naman-B-Parlecha
Copy link
Contributor

@Naman-B-Parlecha Naman-B-Parlecha commented May 24, 2025

This PR adds a GitHub Actions workflow to automatically label pull requests for better maintainability:

  • Size Labels: Applies XS (0-19 lines), S (20-49), M (50-199), L (200-799), XL (800-1999), or XXL (2000+ lines) based on lines changed.
  • File-Based Labels: Applies docs, frontend, backend labels based on the files changed
  1. Why Automation?
    • Reduces manual tagging errors.
    • Helps teams filter PRs.
  2. How It Works
    • size-label-action: Uses PR diff stats to assign size labels.
    • labeler: Scans file paths against regex rules in labeler.yml.

Setup for Maintainer :

  1. Create Labels in Issues Tab:

    • size/XS,size/S, size/M, size/L, size/XL, size/XXL
    • docs, frontend, backend.
  2. The workflows will automatically run whenever a pr is opened, changed, reopened


POC

image


Summary by CodeRabbit

  • New Features
    • Introduced automated labeling for pull requests based on file changes and size.
    • Pull requests are now automatically labeled as docs, frontend, or backend depending on the files modified.
    • Size-based labels (XS, S, M, L, XL, XXL) are added to pull requests according to the number of lines changed.

Signed-off-by: Naman-B-Parlecha <namanparlecha@gmail.com>
Copy link

coderabbitai bot commented May 24, 2025

Walkthrough

Two new GitHub configuration files are introduced: .github/labeler.yml for defining file-based label rules, and .github/workflows/pr_labeler.yml for automating pull request labeling. The workflow assigns size labels based on changed lines and applies custom labels according to file patterns specified in the labeler configuration.

Changes

File(s) Change Summary
.github/labeler.yml Added configuration defining label rules for docs, frontend, and backend based on file paths
.github/workflows/pr_labeler.yml Added workflow automating PR labeling with size and file-based labels using defined rules

Sequence Diagram(s)

sequenceDiagram
    participant GitHubUser as GitHub User
    participant GitHub as GitHub
    participant PRLabeler as PR Labeler Workflow

    GitHubUser->>GitHub: Open/Synchronize/Reopen Pull Request
    GitHub->>PRLabeler: Trigger PR Labeler Workflow
    PRLabeler->>GitHub: Assign size label (XS, S, M, L, XL, XXL)
    PRLabeler->>GitHub: Assign file-based labels (docs, frontend, backend)
Loading

Poem

A rabbit hops through fields of code,
With labels ready for each new load.
Docs, frontend, backend—neatly tagged,
And PR sizes, never lagged!
Workflows run with gentle cheer,
Making reviews swift and clear.
🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

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.

Actionable comments posted: 4

🧹 Nitpick comments (4)
.github/labeler.yml (1)

19-19: Add newline at end of file

A newline is required at the end of .github/labeler.yml to satisfy POSIX compatibility and avoid YAML parsing warnings.

🧰 Tools
🪛 YAMLlint (1.37.1)

[error] 19-19: no new line character at the end of file

(new-line-at-end-of-file)

.github/workflows/pr_labeler.yml (3)

20-20: Remove trailing whitespace

There is trailing whitespace on the blank line after configuration-path: .github/labeler.yml, which may trigger lint errors.

Apply this diff:

-          configuration-path: .github/labeler.yml  
+          configuration-path: .github/labeler.yml
🧰 Tools
🪛 YAMLlint (1.37.1)

[error] 20-20: trailing spaces

(trailing-spaces)


40-40: Add newline at end of file

A newline at the end of the workflow file is recommended for POSIX compliance and to avoid YAML warnings.

🧰 Tools
🪛 YAMLlint (1.37.1)

[error] 40-40: no new line character at the end of file

(new-line-at-end-of-file)


1-6: Consider reordering jobs for clarity

Defining the size-label job before its dependent file-labeler job improves readability of the workflow.

Example:

 jobs:
-  file-labeler:
+  size-label:
     permissions:
       contents: read
       pull-requests: write
     runs-on: ubuntu-latest
     steps:
       …
-  size-label:
+  file-labeler:
     needs: size-label
     runs-on: ubuntu-latest
     steps:
       …
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a28fb43 and 89861fe.

📒 Files selected for processing (2)
  • .github/labeler.yml (1 hunks)
  • .github/workflows/pr_labeler.yml (1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.37.1)
.github/labeler.yml

[warning] 16-16: wrong indentation: expected 0 but found 2

(indentation)


[error] 19-19: no new line character at the end of file

(new-line-at-end-of-file)

.github/workflows/pr_labeler.yml

[error] 20-20: trailing spaces

(trailing-spaces)


[error] 40-40: no new line character at the end of file

(new-line-at-end-of-file)

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.

1 participant