Repository navigation
Run the changelog check only where it can read the pull request - #3
Merged
Merged
Conversation
`package / changelog` failed on every push to main, including the commit that created the repository, which had nothing to check. require-changelog takes the two commits of the pull request and the workflow reads them from `github.event.pull_request.base.sha`. On a push that context is empty, so the script is handed one argument where it expects two and exits 3 on its own usage. The check was reporting a defect in the workflow that called it, on every merge, next to the two checks that were telling the truth. The keel repository already gates the job with `if: github.event_name == 'pull_request'`; this is the same line. A job whose condition is false is reported to the branch protection rule as skipped, which satisfies a required status, so requiring `package / changelog` on main keeps working and the check is still a real run on the pull request, which is the only place it has anything to compare.
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
1 participant
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.
package / changelogfailed on every push to main, including the committhat created the repository, which had nothing to check.
require-changelog takes the two commits of the pull request and the
workflow reads them from
github.event.pull_request.base.sha. On a pushthat context is empty, so the script is handed one argument where it
expects two and exits 3 on its own usage. The check was reporting a
defect in the workflow that called it, on every merge, next to the two
checks that were telling the truth.
The keel repository already gates the job with
if: github.event_name == 'pull_request'; this is the same line. A jobwhose condition is false is reported to the branch protection rule as
skipped, which satisfies a required status, so requiring
package / changelogon main keeps working and the check is still a realrun on the pull request, which is the only place it has anything to
compare.