-
Notifications
You must be signed in to change notification settings - Fork 52
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Introduce a separate GHA workflow for Pull Request Validation to validate the correct commit hashes #269
Introduce a separate GHA workflow for Pull Request Validation to validate the correct commit hashes #269
Conversation
… commit that kicks off the workflow
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for looking into this problem !
I may need some education on how this thing work after the change. left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cleanup looks great, thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice segment-reuse in build-run-tests
!
Summary
This PR adds a new workflow which largely reuses the existing workflow for building/creating images, except that it runs on pull requests but also uses the correct hashes. The PR workflow also has some optimizations to cancel the previous test run on the same PR if a new commit is pushed since that test result is outdated.
Issue] Briefly discuss the summary of the changes made in this
pull request in 2-3 lines.
For all the boxes checked, please include additional details of the changes made in this pull request.
The workflow on the main branch appears to be using the merge commit SHA for tagging purposes: https://github.com/anothrNick/github-tag-action
However this causes issues where it can use outdated hashes of pull requests due to using
github.event.pull_request.merge_commit_sha
which does not seem consistent with the Pull Request HEAD SHA.Documentation on the default behavior here that should fix it https://github.com/actions/checkout/blob/main/README.md
This can cause PRs to have breaking commits but due to this workflow file can pass the CI tests, making it difficult to work in the repository. Another side effect of the PR is that committers branches that have multiple commits may have difficulty debugging their failing workflows locally since the CI tests are running on outdated files.
See testing below for replication of the issue.
Changes
Testing Done
For all the boxes checked, include a detailed description of the testing done for the changes made in this pull request.
Tested locally on my repo
Will-Lo#1 shows a PR with the old behavior which has a clearly breaking change, but is passing tests since the commit that opened the PR passed tests
Will-Lo#3 shows a PR that used to pass with the commit that opened it, but now fails with the same breaking change.
Additional Information
For all the boxes checked, include additional details of the changes made in this pull request.