Repository navigation
ci: Add release labels job to pr.yaml to sync labels/title - #5724
Merged
Merged
Conversation
mtojek
reviewed
Jan 16, 2023
mtojek
self-requested a review
January 16, 2023 09:29
mtojek
approved these changes
Jan 16, 2023
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 script using
actions/github-scripttopr.yaml.This script ensures PR title and labels are in sync:
When release/breaking label is:
When title is:
Notes
I considered adding a new label,
release/use-pr-title. which would tell the release notes generation script to use PR title instead of commit. It would've been added in certain scenarios (e.g. single commit PRs merged with different title than PR).But considering contributors can edit the title of their PR, it's not such a good idea unless we can prevent editing (e.g. via locking the PR). Otherwise a PR title could be edited right before a release and its contents would be out of our control.
Also note: Since we're using the
pull_request_target, only thepr.yamlfrommainwill be used, thus this PR will not run the new check/functionality. I have tested the functionality in another repo.