ci(changelog): list the tag in the PR title #13234
Conversation
- and commit subject - use GHA [`github` context](https://docs.github.com/en/actions/learn-github-actions/contexts#github-context) for the ref name - also "updated" -> "update" for active voice/present tense Signed-off-by: Anton Gilgur <[email protected]>
agilgur5
added
area/docs
|
This and #13235 are independent of each other, so that would not be best practice (they were, in fact, intentionally split apart), as said several times previously by multiple contributors. |
| title: 'docs: updated CHANGELOG.md' | ||
| commit-message: 'docs: updated CHANGELOG.md' | ||
| title: 'docs: update CHANGELOG.md for ${{ github.ref_name }}' | ||
| commit-message: 'docs: update CHANGELOG.md for ${{ github.ref_name }}' |
There was a problem hiding this comment.
I guess there's no good way to test this, huh? In that case, I just wanted to make sure there was no risk of ${{ github.ref_name }} not getting evaluated or not getting evaluated correctly, but I do see it listed here as "The short ref name of the branch or tag that triggered the workflow run. This value matches the branch or tag name shown on GitHub." which in this case should be the tag. So, I think I'm good.
There was a problem hiding this comment.
Other than making a fork and triggering actions (which is very tedious) unfortunately not.
act is the closest equivalent for local running, and it doesn't quite support everything either; not sure if it would work for this one. There is no official GItHub supported way otherwise 😕
And yes that's one of the reasons I linked the docs -- so that a reviewer could at least syntactically check
|
@terrytangyuan this is blocked on your request changes |
(cherry picked from commit 11ad50a)
|
Can confirm this worked for #13423 . Only thing is that, per #13414 (comment), this PR must apparently be cherry-picked into the release branch for it to take effect from a push of a tag off that branch. |
Motivation
Make the automated changelog PRs have distinct titles for easy at-a-glance readability
Modifications
add the tag in the PR title and commit subject for the
changelog.yamlGHA Workflowgithubcontext for the ref namealso "updated" -> "update" for active voice/present tense
Verification