Repository navigation
docs(release): CHANGELOG.md, its notes on top of each release, and the release fails without them - #118
Merged
Conversation
…e release fails without them Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0182yxsfwRowwnxCfgrQwjnA
stefanoghinelli
approved these changes
Nov 18, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0182yxsfwRowwnxCfgrQwjnA
Contributor
Author
|
Merged without a new review on Teg's OK: only the merge of main after Stefano's approval, resolving the conflict in mise.toml by keeping both test lines (tools/operator/test-urbex-op.sh and tools/release/test-notes.sh). |
2 tasks done
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
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.
Summary
CHANGELOG.md(new), Keep a Changelog, for the CLI,urbex-opand its image (released together):tools/release/notes.sh(new): a tag's notes fromCHANGELOG.md, the section## [X.Y.Z]without its heading; an-rctakes its version's. Fails, saying what to add, without a section or with an empty one..github/workflows/release.yml:goreleaser --release-header): "urbex X - a preview release.", the version's notes, then Install with links to getting started, upgrading, the known limitations and urbex's release of the same tag. GoReleaser's list of commits follows;org.opencontainers.image.url(this release's page) andorg.opencontainers.image.documentation(getting started).tools/release/test-notes.sh(new), inmise run test: a section, an rc, a missing and an empty section, and this repository's own 0.1.0.README.md: the changelog and the rule; the release paragraph.The
header:of.goreleaser.yamlstays, for local and snapshot runs.Why
urbforge/redemptor#54: v0.1.0's release had only a generated list of commits, with no highlights, breaking changes or upgrade steps, and nothing on the image pointed to it. Before the next release.
Tests I ran
tools/release/test-notes.sh: 5 ok.mise run test: passes.v0.1.0(RUNNER_TEMP,GORELEASER_CURRENT_TAGset as the workflow does): the intro, the 0.1.0 notes, then Install with its links.goreleaser release --help: 2.19 has--release-header. The workflow parses as YAML.-rcfirst).Checklist before review
Part of urbforge/redemptor#54, with urbforge/urbex#90 and urbforge/redemptor#55.
🤖 Generated with Claude Code
https://claude.ai/code/session_0182yxsfwRowwnxCfgrQwjnA