Repository navigation
ci: check PR titles for Conventional Commits - #269
Merged
Merged
Conversation
Release Please ignores PR titles that are not Conventional Commits, so changes silently vanish from the changelog. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-actions
Bot
added
documentation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The title guard can be bypassed through a contributor-controlled branch name and incorrectly rejects valid Conventional Commit titles with uppercase scopes.
2 open issues
What changed in this PR
This PR adds PR-title validation to help Release Please include squash-merged changes in the changelog.
Changes:
- Adds a Conventional Commit title check, with an exemption for Release Please branches.
- Clarifies that PR titles must not start with emojis and that maintainers must use squash merging.
| File | Description |
|---|---|
CONTRIBUTING.md |
Clarifies title formatting and squash-merge requirements. |
.github/workflows/pr-title.yml |
Adds automated PR-title validation using an environment-provided title. |
Review effort: Balanced
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
pinact 5.0.2 fails with pinact/config-error on every workflow change because the trunk plugins still pass single-dash flags. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
| name: PR Title | ||
|
|
||
| on: | ||
| pull_request: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Release Please builds the changelog from the PR title of squash-merged pull requests. #267 was merged as a plain merge commit and its title and commits start with an emoji, so Release Please logged
commit could not be parsedand the change is missing from the release PR (#250).This PR adds a guard so that this cannot happen silently again.
Changes
PR Titleworkflow that fails when the PR title is not a valid Conventional Commit (feat,fix,refactor,perf,docs,style,chore,test,build,ci,revert, optional scope, optional!). The Release Please PR (release-please--*branches) is skipped. The title is passed viaenvand only used as regex match data.CONTRIBUTING.md: PR titles must not start with an emoji (commit messages inside the PR may), and plain merge / rebase merges must not be used.Follow-up for maintainers
The workflow cannot prevent a plain merge. In Settings > General > Pull Requests, disable "Allow merge commits" and "Allow rebase merging", keep "Allow squash merging" with "Default to pull request title". Optionally add
PR Titleas a required status check.Testing
feat(hyva): add check,feat: implement x,chore: upgrade trunk linters,fix!: changeandfeat(deps-dev): update infection/infection requirement(accepted) and against✨ feat(hyva): xandNext Release 0.29.0(rejected, the latter is skipped by the branch condition).trunk checkon the markdown file is clean. The localpinactrun reports a tool configuration error (unknown flag: -format) for every workflow, including the existinglabel.yml.