GH Actions: safeguard the PR label workflow some more #89
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
0944e52 to
c168993
Compare
The `srvaroa/labeler` action runner will use the `labeler.yml` from the repo's default branch by default, which is good from a security perspective, but that means that PRs changing the `labeler.yml` file will not be tested until they have been merged and a _next_ PR is opened.
As the `srvaroa/labeler` action runner will silently fail, this also means that the labeling will stop working without any indication (other than labels no longer being added).
I'd like to prevent getting into that situation (again). The `yamllint` workflow I introduced earlier is already a big step in the right direction.
This commit introduces a second safeguard:
* It adds a second job to the workflow which will only run when the files relevant for the workflow are being changed in a PR.
* In that case, this second job will:
- run with the PR-local version of the `labeler.yml` file;
- run on **_all_** pull request events (except merge), not only when the PR is opened.
- fail the workflow run if any errors are encountered.
This should make sure that this workflow is safeguarded properly and will continuing functioning as intended, even when changes are made to the logic.
Refs:
* srvaroa/labeler#105
5f3580f to
c7f23e2
Compare
|
Tested by deliberately introducing a yaml error in the |
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.
Description
The
srvaroa/labeleraction runner will use thelabeler.ymlfrom the repo's default branch by default, which is good from a security perspective, but that means that PRs changing thelabeler.ymlfile will not be tested until they have been merged and a next PR is opened.As the
srvaroa/labeleraction runner will silently fail, this also means that the labeling will stop working without any indication (other than labels no longer being added).I'd like to prevent getting into that situation (again). The
yamllintworkflow I introduced earlier is already a big step in the right direction.This commit introduces a second safeguard:
labeler.ymlfile; - run on all pull request events (except merge), not only when the PR is opened. - fail the workflow run if any errors are encountered.This should make sure that this workflow is safeguarded properly and will continuing functioning as intended, even when changes are made to the logic.
Suggested changelog entry
N/A
Related issues/external references