Skip to content

docs(release): CHANGELOG.md, its notes on top of each release, and the release fails without them - #118

Merged
Teg79 merged 2 commits into
mainfrom
docs/changelog
Nov 18, 2026
Merged

Teg79 merged 2 commits into
mainfrom
docs/changelog

Conversation

@Teg79

@Teg79 Teg79 commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • CHANGELOG.md (new), Keep a Changelog, for the CLI, urbex-op and its image (released together):
    • an Unreleased section;
    • the 0.1.0 entry, retroactive: what the first preview release has (Added), Upgrading, and the known limitations;
    • the rule: a PR that changes what users see adds a line under Unreleased.
  • tools/release/notes.sh (new): a tag's notes from CHANGELOG.md, the section ## [X.Y.Z] without its heading; an -rc takes its version's. Fails, saying what to add, without a section or with an empty one.
  • .github/workflows/release.yml:
    • the test job checks the notes first, so a tag without an entry fails before anything is built;
    • the GitHub release opens with them (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;
    • the image carries org.opencontainers.image.url (this release's page) and org.opencontainers.image.documentation (getting started).
  • tools/release/test-notes.sh (new), in mise 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.yaml stays, 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.
  • The workflow's header step, rendered locally for v0.1.0 (RUNNER_TEMP, GORELEASER_CURRENT_TAG set 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.
  • Not run: the workflow on a tag. It runs at the next release (an -rc first).

Checklist before review

  • Linked issue, Conventional Commit title
  • Tests added
  • No secrets, tokens or private addresses
  • Docs (README; the rule in urbforge/redemptor#55)

Part of urbforge/redemptor#54, with urbforge/urbex#90 and urbforge/redemptor#55.

🤖 Generated with Claude Code

https://claude.ai/code/session_0182yxsfwRowwnxCfgrQwjnA

…e release fails without them

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0182yxsfwRowwnxCfgrQwjnA
@Teg79
Teg79 merged commit cf0d4db into main Nov 18, 2026
1 check passed
@Teg79

Teg79 commented Nov 18, 2026

Copy link
Copy Markdown
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).

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.

2 participants