Preview the notes of the next Release locally #48

Closed
opened 2026-10-10 11:33:18 +00:00 by piscis · 0 comments
Owner

Parent

#45

What to build

A maintainer can print the notes of the next Release locally, without creating anything. The notes are what CI will later post as the Release for the current Image tag.

  • make release-notes runs git-cliff as a digest-pinned container image, the same way the existing linters are run. No Node toolchain enters the repo.

  • Header built from the Pin:

    • the Upstream Version, with a link to Upstream's release for it;
    • the Rebuild number;
    • whether the Upstream Version changed since the previous Release.

    This covers Upstream bumps, which Renovate commits as chore(deps) and which the commit groups would otherwise hide.

  • Body: Conventional Commits groups for feat, fix, perf and breaking changes since the previous Release.

    • Commits scoped scripts, skills, renovate, agents or ci are skipped as repo-internal.
    • A commit with no scope, or scoped image, affects Consumers and is included.
    • Non-conventional merge commits are skipped, but the conventional commits inside them still count.
  • Previous Release: the nearest earlier Release tag on the history of main (git ancestry), never semver ordering. As semver, 3.2.0-r10 would sort before 3.2.0-r2. With no Release tag yet, the notes run from the start of the history.

  • The dry run prints the notes and the create-release request payload it would send: tag name equal to the Image tag (no v prefix), and target commit.

  • The agent docs list the internal scopes and the rule that a change with no scope, or scoped image, shows up in Release notes.

Acceptance criteria

  • make release-notes prints a header and notes for the Image tag from make print-tag, and creates nothing
  • The header names the Upstream Version with a link to its Upstream release, the Rebuild number, and whether the Upstream Version changed
  • Commits with an internal scope are left out. With the Pin at 3.2.0-r2 and a local 3.2.0-r1 tag on that Image's revision, the notes contain the Go 1.27 fix and leave out #43 and #44, and the header shows v3.2.0, Rebuild 2, Upstream Version unchanged
  • The previous Release is found by ancestry, not by sorting tags
  • The git-cliff image is pinned by digest
  • The internal-scope list is documented in the agent docs

Blocked by

None (can start immediately).

## Parent #45 ## What to build A maintainer can print the notes of the next Release locally, without creating anything. The notes are what CI will later post as the Release for the current Image tag. - `make release-notes` runs git-cliff as a digest-pinned container image, the same way the existing linters are run. No Node toolchain enters the repo. - **Header built from the Pin:** - the Upstream Version, with a link to Upstream's release for it; - the Rebuild number; - whether the Upstream Version changed since the previous Release. This covers Upstream bumps, which Renovate commits as `chore(deps)` and which the commit groups would otherwise hide. - **Body:** Conventional Commits groups for `feat`, `fix`, `perf` and breaking changes since the previous Release. - Commits scoped `scripts`, `skills`, `renovate`, `agents` or `ci` are skipped as repo-internal. - A commit with no scope, or scoped `image`, affects Consumers and is included. - Non-conventional merge commits are skipped, but the conventional commits inside them still count. - **Previous Release:** the nearest earlier Release tag on the history of main (git ancestry), never semver ordering. As semver, `3.2.0-r10` would sort before `3.2.0-r2`. With no Release tag yet, the notes run from the start of the history. - The dry run prints the notes and the create-release request payload it would send: tag name equal to the Image tag (no `v` prefix), and target commit. - The agent docs list the internal scopes and the rule that a change with no scope, or scoped `image`, shows up in Release notes. ## Acceptance criteria - [ ] `make release-notes` prints a header and notes for the Image tag from `make print-tag`, and creates nothing - [ ] The header names the Upstream Version with a link to its Upstream release, the Rebuild number, and whether the Upstream Version changed - [ ] Commits with an internal scope are left out. With the Pin at `3.2.0-r2` and a local `3.2.0-r1` tag on that Image's revision, the notes contain the Go 1.27 fix and leave out #43 and #44, and the header shows v3.2.0, Rebuild 2, Upstream Version unchanged - [ ] The previous Release is found by ancestry, not by sorting tags - [ ] The git-cliff image is pinned by digest - [ ] The internal-scope list is documented in the agent docs ## Blocked by None (can start immediately).
Sign in to join this conversation.
No description provided.