Skip to content

GH Actions: more website update workflow tweaks - #583

Merged
schlessera merged 1 commit into
developfrom
feature/ghactions-more-tweaks
Nov 5, 2021
Merged

schlessera merged 1 commit into
developfrom
feature/ghactions-more-tweaks

Conversation

@jrfnl

@jrfnl jrfnl commented Nov 1, 2021

Copy link
Copy Markdown
Member

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 jrfnl added this to the 2.0.0 milestone Nov 1, 2021
@jrfnl
jrfnl requested a review from schlessera November 1, 2021 03:18
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
jrfnl force-pushed the feature/ghactions-more-tweaks branch from 92f5c5a to 767f762 Compare November 5, 2021 08:53
@schlessera
schlessera merged commit 0307d96 into develop Nov 5, 2021
@schlessera
schlessera deleted the feature/ghactions-more-tweaks branch November 5, 2021 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants