Skip to content

CI: really include ChangeLog via gh rel edit - #51

Open
knocte wants to merge 5 commits into
masterfrom
wip/fixReleaseJobToIncludeChangeLog
Open

CI: really include ChangeLog via gh rel edit#51
knocte wants to merge 5 commits into
masterfrom
wip/fixReleaseJobToIncludeChangeLog

Conversation

@knocte

@knocte knocte commented May 27, 2026

Copy link
Copy Markdown
Contributor

Since the tag was manually pushed, GitHub automatically created a lightweight release/tag placeholder on GitHub because of the pushed tag (or because of some automatic UI
configuration/behavior). When gh release create "${{ env.HEAD_TAG }}" ran, GitHub might have replied "Release already exists" (or did not overwrite the existing notes/placeholder because it was already created with the default commit message "chore: release v0.0.755").

To fix this and make it extremely reliable: if the release already exists (or gh release create fails or skips because it's already there), we fallback to gh release edit with:

gh release edit "${{ env.HEAD_TAG }}" --notes-file CHANGELOG_RELEASE.md

This guarantees that even if a placeholder is pre-created by GitHub because of the pushed tag, we overwrite and update its release notes with our newly generated conventional changelog block! Updated publish.yml to support this create || edit fallback.

knocte added 2 commits May 27, 2026 20:41
Since the tag was manually pushed, GitHub automatically created
a lightweight release/tag placeholder on GitHub because of the
pushed tag (or because of some automatic UI
configuration/behavior). When gh release create
"${{ env.HEAD_TAG }}" ran, GitHub might have replied "Release
already exists" (or did not overwrite the existing
notes/placeholder because it was already created with the
default commit message "chore: release v0.0.755").

To fix this and make it extremely reliable: if the release
already exists (or gh release create fails or skips because
it's already there), we fallback to gh release edit with:

````
gh release edit "${{ env.HEAD_TAG }}" --notes-file CHANGELOG_RELEASE.md
````

This guarantees that even if a placeholder is pre-created by
GitHub because of the pushed tag, we overwrite and update its
release notes with our newly generated conventional changelog
block! Updated publish.yml to support this create || edit
fallback.
I did small manual tweaks to release notes after
tagging, so let's make them match to this .md file.
@knocte
knocte force-pushed the wip/fixReleaseJobToIncludeChangeLog branch from 0c9d658 to e0a2160 Compare May 28, 2026 01:20
@knocte
knocte force-pushed the wip/fixReleaseJobToIncludeChangeLog branch from e0a2160 to 81bc02b Compare May 28, 2026 04:17
@knocte
knocte force-pushed the wip/fixReleaseJobToIncludeChangeLog branch from 22d2ed6 to a26177f Compare May 28, 2026 07:09
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.

1 participant