DX-2192: build release notes from export commit markers#48
Draft
lloyd-cio wants to merge 2 commits into
Draft
Conversation
Assemble release notes from the marker-wrapped blocks the public export embeds in each export commit since the previous tag, and pass them via --release-notes. Falls back to GoReleaser's default when no markers exist.
The generated notes populate a draft release; a human reviews and publishes.
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.
Part 2 of 2 for meaningful public CLI release notes (DX-2192). Pairs with cio-cli#123 (which embeds the notes in export commits).
At release time, assemble GoReleaser notes from the marker-wrapped blocks the export embeds in each commit since the previous tag, and have a human review before publishing.
release-workflow.js: newbuild-release-notescommand — extracts<!-- release-notes:start/end -->blocks from export commits in<prev-tag>..HEAD, writes a notes file, emitsnotes_flag.release.yml:github_releasebuilds notes and passes${{ steps.notes.outputs.notes_flag }}(--release-notes=<file>) to GoReleaser. Empty when no markers → GoReleaser default notes, so safe to land before/without cio-cli#123..goreleaser.yaml:release.draft: true— GoReleaser creates the release as a draft populated with the generated notes; a human reviews and clicks Publish.extractNotesBlock.Behavior change to note: the GitHub release page is now a draft until a human publishes it. npm + GitHub Packages still publish automatically (existing downstream jobs are unchanged) — the human gate is on the release notes/page, not the artifacts.
Validated:
node -c, actionlint, goreleaser YAML parses, unit tests pass, functional run against a synthetic repo. GoReleaser/Copybara themselves only run in CI.Linear: DX-2192