ci: Add GH workflow to validate PR titles follow Conventional Commits. #587
Conversation
|
Warning Rate limit exceeded@LinZhihao-723 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 27 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. WalkthroughThis pull request introduces modifications to the pull request template and adds a new GitHub Actions workflow. The Changes
Possibly related PRs
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
.github/PULL_REQUEST_TEMPLATE.md (3)
2-4: Enhance clarity of the Conventional Commits requirementThe instructions should be more specific about the required format. Consider adding the basic structure of a conventional commit.
Set the PR title to a meaningful commit message that: - follows the Conventional Commits specification (https://www.conventionalcommits.org). - is in imperative form. +- uses the format: <type>[optional scope]: <description> + where type is one of: feat, fix, docs, style, refactor, perf, test, chore, ci, build
5-6: Add more diverse examples of conventional commitsWhile the current example is good, providing multiple examples would better illustrate the variety of commit types.
Example: fix: Don't add implicit wildcards ('*') at the beginning and the end of a query (fixes #390). +Additional examples: +feat(parser): Add support for parsing multi-line logs +docs: Update installation instructions for Windows users +perf: Optimize memory usage in log processing
Line range hint
1-14: Consider adding validation section for PR titlesSince this template is being updated alongside a new GitHub workflow for PR title validation, it would be helpful to mention the automated checks.
+Note: Your PR title will be automatically checked to ensure it follows the Conventional Commits format. +If the check fails, please revise your PR title according to the format above. + # Description
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
.github/PULL_REQUEST_TEMPLATE.md(1 hunks).github/workflows/clp-pr-title-checks.yaml(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- .github/workflows/clp-pr-title-checks.yaml
Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
|
Tested after moving permission to job level and it should be good: https://github.com/LinZhihao-723/clp/actions/runs/11807413560 |
y-scope#587) Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
Description
Convention Commits is a specification for writing commit messages (or in our case, PR titles) that makes it easy to see at a glance what change the commit makes which in turn makes it easier to generate release notes.
This PR adds a workflow to check PR titles match the spec.
Validation performed
Summary by CodeRabbit
New Features
Documentation
Chores