ci: Add GH workflow to validate PR titles follow Conventional Commits (fixes #43). #48
Conversation
WalkthroughThe changes in this pull request involve modifications to the pull request template and the introduction of a new GitHub Actions workflow. The Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant GitHub
participant Action
User->>GitHub: Open/Edit/Reopen Pull Request
GitHub->>Action: Trigger pr-title-checks workflow
Action->>GitHub: Check Pull Request Title
GitHub->>User: Provide Feedback on Title
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
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: 1
🧹 Outside diff range and nitpick comments (1)
.github/workflows/pr-title-checks.yaml (1)
15-23: Consider customizing the semantic validation rulesWhile the basic configuration is secure and functional, consider adding custom validation rules to better match your project's needs. The action supports additional configuration options such as:
- Custom commit types
- Scope validation
- Custom error messages
Example configuration:
- uses: "amannn/action-semantic-pull-request@v5" env: GITHUB_TOKEN: "${{secrets.GITHUB_TOKEN}}" + with: + types: | + feat + fix + docs + style + refactor + perf + test + build + ci + chore + requireScope: false + wip: true
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
.github/PULL_REQUEST_TEMPLATE.md(1 hunks).github/workflows/pr-title-checks.yaml(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- .github/PULL_REQUEST_TEMPLATE.md
🔇 Additional comments (1)
.github/workflows/pr-title-checks.yaml (1)
8-12: Well-implemented concurrency settings!
The concurrency configuration effectively prevents redundant checks and improves workflow efficiency by cancelling outdated runs. The commenting is clear and helpful.
Co-authored-by: kirkrodrigues <[email protected]>
References
Description
This PR implements #43
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