Prepare the release flow for enabling immutable releases#396
Open
Prepare the release flow for enabling immutable releases#396
Conversation
- Create GitHub release as draft with --generate-notes, removing the need for a manually maintained CHANGELOG.md - Add finalize-release job that marks the release as non-draft after crate publishing and binary uploads complete - Make all steps idempotent for safe retries: tags check commit identity, draft release skips if exists, assets clobber only drafts - Fail hard if a published release already exists (immutability) - Delete CHANGELOG.md and update docs/Development.md
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.
Further context: https://docs.github.com/en/code-security/concepts/supply-chain-security/immutable-releases
With this change we first create a release draft, then attach all artifacts (like compiled binaries) and only then mark the release as complete/final. It's a safe process that may be repeated in case of any issues without problem, unless the release has been already cut.
Additionally, I replaced
CHANGELOG.mdwith--generate-notesargument forgh release. Not much of a difference and it makes the process easier.