ci: Add a workflow to check pull request title for correct prefix. #3080
Conversation
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
|
Does manually re-running the workflow allow it to see the updated title? |
tippmar-nr
reviewed
Apr 3, 2025
| contents: read | ||
| pull-requests: read | ||
| steps: | ||
| - name: Check PR title |
There was a problem hiding this comment.
Need to add Harden Runner step here.
- name: Harden Runner
uses: step-security/harden-runner@c6295a65d1254861815972266d5933fd6e532bdf # v2.11.1
with:
disable-sudo: true
egress-policy: audit
|
Looks like there's already an action that does the same thing https://github.com/marketplace/actions/pr-title-checker - I wonder if it handles PR title changes? |
Unfortunately no. |
|
Marty found a better solution, closing this hand-rolled attempt. |
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.
This PR adds a workflow to check the prefix of pull request titles to make sure that the start with a prefix and that the prefix is in the list of known good prefixes: feat, fix, security, notice, ci, chore, test, docs
I initially tested this in my fork. Unfortunately, the PR title as seen by the workflow logic does not get updated after PR creation. In other words, you can edit and change the PR title after initial creation, but the workflow only ever gets the initial value. So, if this check finds a problem with the PR title, the solution is to close the PR with the "bad" title/prefix and open another one with a correct prefix.