[NET-11150] ci: fix conditional skip and add safeguard #637
Conversation
This file contains 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
zalimeni
force-pushed
the
zalimeni/fix-ci-skip-action
branch
from
1cb4f28
to
dff57c4
Compare
zalimeni
added
pr/no-changelog
zalimeni
force-pushed
the
zalimeni/fix-ci-skip-action
branch
4 times, most recently
from
f764902
to
835293b
Compare
zalimeni
requested review from
rboyer,
jm96441n,
NiniOak and
sarahalsmiller
zalimeni
commented
Sep 24, 2024
Comment on lines
+14
to
+19
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| - release/** | ||
| pull_request: |
There was a problem hiding this comment.
This ensures we're using the triggers expected by the workflow. Mixing pull_request and push triggers for PRs means we can get falsely passing required checks due to diff'ing only the latest commit (the expected behavior on push), because there's no base_ref or "magic GH-only merge commit" to rely on since the push trigger is in the context of the feature branch in isolation rather than a PR merge branch (pull_request). More on this here: https://github.com/orgs/community/discussions/26243
The safeguard added to the reusable workflow enforces this by checking for either base_ref or protected branch status (what we'd expect on push).
| - name: Check for skippable file changes | ||
| id: changed-files | ||
| uses: tj-actions/changed-files@v45 |
There was a problem hiding this comment.
This action is used in other hashicorp repos and is allow-listed:
❯ tsccr-helper gha allowlist -any-version | grep changed-files
tj-actions/changed-files@*
tj-actions/verify-changed-files@*
zalimeni
changed the title
NiniOak
reviewed
Sep 24, 2024
NiniOak
approved these changes
Sep 24, 2024
zalimeni
force-pushed
the
zalimeni/fix-ci-skip-action
branch
2 times, most recently
from
9d6e228
to
135c745
Compare
zalimeni
commented
Sep 24, 2024
| # The ability to do this is ultimately determined by the triggers of the calling | ||
| # workflow, since `base_ref` (the target branch of a PR) is only available in | ||
| # `pull_request` events, not `push`. | ||
| - name: Error if conditional check is not allowed |
There was a problem hiding this comment.
Post-review note: updated this job name for clarity, since it's expected to be skipped if things are working correctly.
This was referenced Sep 24, 2024
zalimeni
added a commit
to hashicorp/consul
that referenced
this pull request
Sep 25, 2024
Adopt a third-party action to avoid script bugs, and to fix a current issue where the script fails to detect all changes when processing push events on PR branches. Adapted from hashicorp/consul-dataplane#637. See that PR for testing details and background context.
zalimeni
added a commit
to hashicorp/consul
that referenced
this pull request
Sep 25, 2024
Adopt a third-party action to avoid script bugs, and to fix a current issue where the script fails to detect all changes when processing push events on PR branches. Adapted from hashicorp/consul-dataplane#637. See that PR for testing details and background context.
zalimeni
added a commit
to hashicorp/consul-k8s
that referenced
this pull request
Sep 25, 2024
Adopt a third-party action to avoid script bugs, and to fix a current issue where the script fails to detect all changes when processing push events on PR branches. Adapted from hashicorp/consul-dataplane#637. See that PR for testing details and background context.
2 tasks
zalimeni
added a commit
to hashicorp/consul-k8s
that referenced
this pull request
Sep 25, 2024
Adopt a third-party action to avoid script bugs, and to fix a current issue where the script fails to detect all changes when processing push events on PR branches. Adapted from hashicorp/consul-dataplane#637. See that PR for testing details and background context.
zalimeni
added a commit
to hashicorp/consul-k8s
that referenced
this pull request
Sep 25, 2024
Adopt a third-party action to avoid script bugs, and to fix a current issue where the script fails to detect all changes when processing push events on PR branches. Adapted from hashicorp/consul-dataplane#637. See that PR for testing details and background context.
zalimeni
added a commit
to hashicorp/consul
that referenced
this pull request
Sep 25, 2024
Adopt a third-party action to avoid script bugs, and to fix a current issue where the script fails to detect all changes when processing push events on PR branches. Adapted from hashicorp/consul-dataplane#637. See that PR for testing details and background context.
Adopt a third-party action to avoid script bugs, and to fix a current issue where the script fails to detect all changes when processing push events on PR branches.
zalimeni
force-pushed
the
zalimeni/fix-ci-skip-action
branch
from
135c745
to
b13c5cd
Compare
|
Updated |
This was referenced Sep 25, 2024
zalimeni
added a commit
to hashicorp/consul
that referenced
this pull request
Sep 25, 2024
ci: fix conditional skip and add safeguard Adopt a third-party action to avoid script bugs, and to fix a current issue where the script fails to detect all changes when processing push events on PR branches. Adapted from hashicorp/consul-dataplane#637. See that PR for testing details and background context.
zalimeni
added a commit
to hashicorp/consul-k8s
that referenced
this pull request
Sep 25, 2024
ci: fix conditional skip and add safeguard Adopt a third-party action to avoid script bugs, and to fix a current issue where the script fails to detect all changes when processing push events on PR branches. Adapted from hashicorp/consul-dataplane#637. See that PR for testing details and background context.
This was referenced Sep 25, 2024
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.
Fix CI skip workflow by adopting
tj-actions/changed-files(used by several otherhashicorprepos) and putting in safeguards to avoid false negatives on changed files due to inappropriate workflow triggers.Reproduced bug (skipped checks on
Dockerfilechange): https://github.com/hashicorp/consul-dataplane/actions/runs/10984338025/job/30494819791?pr=630#step:3:14Debugging 🧵 for posterity, which has some notes w/ more background on our previous script and potential gotchas: https://go.hashi.co/net-11150-debugging-slack
PRs for other repos:
Testing
pull_requestretrieves changes between base and feature branch: https://github.com/hashicorp/consul-dataplane/actions/runs/11017376755/job/30595124657?pr=637#step:4:64Prints both skippable and non-skippable files: https://github.com/hashicorp/consul-dataplane/actions/runs/11017376755/job/30595124657?pr=637#step:5:12
Skip test: https://github.com/hashicorp/consul-dataplane/actions/runs/11018306352/job/30598259268?pr=638#step:6:6
Safeguard test: https://github.com/hashicorp/consul-dataplane/actions/runs/11016637261/job/30592629656?pr=636#step:2:14
Simulated
pushwith non-skippable commit (diff is just latest commit): https://github.com/hashicorp/consul-dataplane/actions/runs/11020606567/job/30605759628#step:3:62Simulated
pushwith skippable commit (diff is just latest commit): https://github.com/hashicorp/consul-dataplane/actions/runs/11020613882/job/30605785364#step:4:12