fix: stop GitHub release pipeline marking releases pre-release with empty notes#967
Merged
Merged
Conversation
…mpty notes The GitHubRelease@1 task hardcoded isPreRelease: true and addChangeLog: false with no release-notes source, so every published release landed flagged pre-release (not Latest) with an empty body. - Set IsPreRelease from the wheel version (plain X.Y.Z -> real release; any PEP 440 suffix -> pre-release) and read it in the task. - Extract the matching '## WinML CLI v<version>' CHANGELOG section into RELEASE_NOTES.md in the Prepare job (ships in the artifact, since the release job has no checkout) and point releaseNotesFilePath at it. Notes are written BOM-free; missing section degrades to an empty body.
xieofxie
approved these changes
Jun 25, 2026
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
2 participants
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.
The
modelkit-release-github.ymlGitHubRelease@1task hardcodedisPreRelease: trueandaddChangeLog: falsewith no release-notes source, so every published release (e.g. v0.2.0) landed flagged Pre-release, not Latest, with an empty body. The driver had to fix each release by hand withgh release edit --prerelease=false --latest --notes-file ....This makes the pipeline produce the correct release directly:
IsPreReleasefrom the wheel version: a plainX.Y.Zis a real release (false-> marked Latest); any PEP 440 suffix (0.3.0rc1,0.3.0.dev1, ...) is a pre-release (true). The task readsisPreRelease: $(IsPreRelease).## WinML CLI v<version>section fromCHANGELOG.mdintoRELEASE_NOTES.md, which ships in theGitHubReleaseAssetsartifact (the release job has no repo checkout). The task pointsreleaseNotesFilePathat it. A missing section degrades to an empty body with a warning (no worse than today).addChangeLogstaysfalseso the body is exactly the curated CHANGELOG section, not an auto-generated commit list. Notes are written BOM-free.First observed on the v0.2.0 release.