Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,18 @@ These rules are validated by a required workflow and enforced
via GitHub Repository Rulesets, which can block a PR from merging
if the title does not meet the prefix or formatting requirements.

✔ Allowed prefixes (must be EXACT, case-sensitive):
✔ Allowed prefixes (case-insensitive):

Build, Chore, CI, Docs, Feat, Fix, Perf, Refactor, Revert, Style, Test,
Feature, Bug fix, Proposal, Breaking change, Other/Misc

✔ Formatting rules:

- Prefix must appear at the **very start** of the title.
- Prefix must match EXACT CASE (this is enforced by our PR Title
workflow, which validates exact-match prefixes via the
`allowed_prefixes` input of the GitHub Action used). [3](https://kitemetric.com/blogs/automate-github-actions-updates-organization-wide-efficiency)
- Prefix matching is case-insensitive (e.g. fix, Fix, and FIX are all valid)
and validated via the `allowed_prefixes` input of the GitHub Action used. [3](https://kitemetric.com/blogs/automate-github-actions-updates-organization-wide-efficiency)
- Title must be **at least 8 characters long** (enforced by the workflow).
- Use a colon or a space after the prefix (e.g., `Feat: Add feature`).
- Use a colon or a space after the prefix (e.g., `Feat: Add feature`) - recommended.

If your PR title doesn't meet these rules, the required workflow
will fail and merging will be blocked until fixed.
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pr-verifier-required.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ jobs:
pull-requests: read

steps:
- name: Enforce PR title prefixes (case-sensitive)
- name: Enforce PR title prefixes
uses: deepakputhraya/action-pr-title@3864bebc79c5f829d25dd42d3c6579d040b0ef16 # v1.0.2
with:
# Union of conventional and template-derived categories
allowed_prefixes: >
Build,Chore,CI,Docs,Feat,Fix,Perf,Refactor,Revert,Style,Test,
Feature,Bug fix,Proposal,Breaking change,Other,Other/Misc
prefix_case_sensitive: true
prefix_case_sensitive: false
min_length: 8
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
Loading