Repository navigation
GH Actions: more website update workflow tweaks - #583
Merged
Merged
Conversation
1. Change the workflow trigger As it was, the website update PR would be created when a _release_ was published, while from a "human workflow" point of view, it could be considered better to create the website update PR when a new tag is pushed. That way, the website update PR can be reviewed and merged before the release notification is created and mailed out to subscribers/watchers of the repo. 2. Make messages more descriptive The `github.ref` variable contains the tag on release, the branch name on pushes and the PR merge branch name of pull requests. All of these generally prefixed with `refs/pull/`, `refs/heads/` etc Those prefixes decrease the readability of the messages/branch names in which the variable is used. By using `github.ref_name` for pulls and `github.event.release.tag_name` for tags, we should get the "clean" branch/tag name instead.
jrfnl
force-pushed
the
feature/ghactions-more-tweaks
branch
from
November 5, 2021 08:53
92f5c5a to
767f762
Compare
schlessera
approved these changes
Nov 5, 2021
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.
1. Change the workflow trigger
As it was, the website update PR would be created when a release was published, while from a "human workflow" point of view, it could be considered better to create the website update PR when a new tag is pushed.
That way, the website update PR can be reviewed and merged before the release notification is created and mailed out to subscribers/watchers of the repo.
2. Make messages more descriptive
The
github.refvariable contains the tag on release, the branch name on pushes and the PR merge branch name of pull requests. All of these generally prefixed withrefs/pull/,refs/heads/etcThose prefixes decrease the readability of the messages/branch names in which the variable is used.
By using
github.ref_namefor pulls andgithub.event.release.tag_namefor tags, we should get the "clean" branch/tag name instead.