Skip to content

fix: release.yml's github-release job never checked out the repo - #41

Merged
carolsimone merged 1 commit into
mainfrom
fix/release-workflow-checkout
Aug 21, 2026
Merged

fix: release.yml's github-release job never checked out the repo#41
carolsimone merged 1 commit into
mainfrom
fix/release-workflow-checkout

Conversation

@carolsimone

Copy link
Copy Markdown
Owner

What this changes

Adds the missing actions/checkout@v4 step to release.yml's github-release job.

Why

v0.3.1's tag push was this workflow's first real execution — it only triggers on push: 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:

grep: CHANGELOG.md: No such file or directory

The "Extract this version's CHANGELOG section" step silently fell back to generate=true, so v0.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

  • YAML validated.
  • Manually re-ran the extraction logic locally against CHANGELOG.md at 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).
  • The already-published v0.3.1 Release was corrected separately with gh release edit --notes-file using the same extracted text, so this PR only needs to fix future tags, not backfill anything.

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>
@github-advanced-security

Copy link
Copy Markdown

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:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

@carolsimone
carolsimone merged commit 6e1cfb7 into main Aug 21, 2026
8 checks passed
@carolsimone
carolsimone deleted the fix/release-workflow-checkout branch August 21, 2026 13:59
@carolsimone carolsimone mentioned this pull request Aug 22, 2026
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants