fix: release.yml's github-release job never checked out the repo - #41
Merged
Conversation
The v0.3.1 tag push was this workflow's first real execution (it only triggers on push:tags, so no pull_request CI run ever exercises it), and it failed exactly as this predicts: `grep: CHANGELOG.md: No such file or directory`, silently falling back to generated notes instead of the intended changelog section. Manually corrected the already-published v0.3.1 Release notes via `gh release edit` separately; this fixes the workflow itself for v0.3.2 and beyond. Signed-off-by: Simone Carolini <simonecarolini.sc@gmail.com>
|
You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool. What Enabling Code Scanning Means:
For more information about GitHub Code Scanning, check out the documentation. |
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
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.
What this changes
Adds the missing
actions/checkout@v4step torelease.yml'sgithub-releasejob.Why
v0.3.1's tag push was this workflow's first real execution — it only triggers onpush: tags, so no pull_request CI run in #40 ever actually exercised it, and the review missed that the job had no checkout step at all (unlike continuo's version, which this was adapted from). It failed predictably:The "Extract this version's CHANGELOG section" step silently fell back to
generate=true, sov0.3.1's Release shipped with GitHub's auto-generated PR-list notes instead of the CHANGELOG.md section written for it.How it was verified
CHANGELOG.mdat the checked-out commit to confirm the section is there and extracts correctly (it always was — the bug was never getting the file in the first place, not the extraction logic).v0.3.1Release was corrected separately withgh release edit --notes-fileusing the same extracted text, so this PR only needs to fix future tags, not backfill anything.