Skip to content

docs: add v2.0.63 CHANGELOG entry and RELEASING.md#2502

Merged
glifocat merged 3 commits into
mainfrom
docs/v2.0.63-release-notes
May 15, 2026
Merged

docs: add v2.0.63 CHANGELOG entry and RELEASING.md#2502
glifocat merged 3 commits into
mainfrom
docs/v2.0.63-release-notes

Conversation

@glifocat
Copy link
Copy Markdown
Collaborator

@glifocat glifocat commented May 15, 2026

Summary

  • Add CHANGELOG.md rollup entry for v2.0.63 covering everything merged since v2.0.54.
  • Add RELEASING.md documenting the release policy that starts with v2.0.63.

CHANGELOG voice match

The new entry follows the existing CHANGELOG conventions:

  • Bold lead-ins per major change, sentence-case prose body.
  • [BREAKING] prefix on the service-name change, with the workaround inline (no link-out for the fix).
  • Doc link uses a relative path: [setup/lib/install-slug.sh](setup/lib/install-slug.sh).
  • Minor items collapsed to plain bullets at the bottom (Slack scope addition, scratchpad clause, on_wake graceful startup).
  • No PR numbers in the user-facing prose.

RELEASING.md contents

Covers:

  • Goal-framed policy — the goal is to publish a GitHub Release for every package.json bump that lands on main, with releases cut manually by a maintainer. Acknowledges lag between bump and release; intent is timeliness, not strict 1:1.
  • What goes in a release — bold lead-ins, [BREAKING] prefix conventions, doc-link style, no PR numbers in prose.
  • Publishing workflow — bump + CHANGELOG in one commit, draft Release with bare-version title, body mirrors CHANGELOG plus Contributors / New Contributors / Full Changelog.
  • Rollup releases — handling for catchup windows like v2.0.54..v2.0.63, with a one-line "Rollup release covering ..." note in the body.
  • Channels and stability — explicit single-channel model today (every release is stable), with latest/stable/pinned definitions and a placeholder for a future pre-release channel.

Commits

  1. Initial CHANGELOG entry + RELEASING.md skeleton.
  2. Follow-up: soften the per-bump policy and add the "Channels and stability" section, based on review feedback.

Follow-up

Once this lands on main, the v2.0.63 draft GitHub Release body should be updated to mirror the CHANGELOG entry verbatim and link to RELEASING.md at the new relative path. The release body draft is staged at release-v2.0.63/release-body.md in the maintainer's workspace.

If/when #2403 (Release workflow) lands, RELEASING.md should be updated in that PR to reference the workflow and its gates.

Test plan

  • Confirm CHANGELOG.md renders cleanly on GitHub with the new entry above v2.0.54.
  • Confirm RELEASING.md relative link from CHANGELOG.md resolves on GitHub.
  • Confirm doc link [setup/lib/install-slug.sh](setup/lib/install-slug.sh) resolves.
  • Maintainer reviews voice match against prior CHANGELOG entries.

CHANGELOG.md gets a rollup entry covering v2.0.55..v2.0.63 in the
project voice (bold lead-ins, [BREAKING] prefix with inline workaround,
doc links to setup/lib/install-slug.sh, no PR numbers).

RELEASING.md is new and documents the per-bump release policy starting
with v2.0.63: tag every package.json bump, mirror the CHANGELOG entry
into the GitHub Release body, append Contributors and (when relevant)
New Contributors sections, and use rollup framing when multiple bumps
collapsed into one release.
@glifocat glifocat added the PR: Docs Documentation changes label May 15, 2026
glifocat added 2 commits May 15, 2026 20:24
Two revisions in RELEASING.md based on review feedback:

1. Soften the "release per bump" claim. The policy is aspirational and
   release publication is manual, so the opening now states the goal
   ("publish a GitHub Release for every package.json version bump that
   lands on main") and acknowledges that there can be lag between a bump
   merging and the release being cut. Intent: timeliness, not strict 1:1.

2. Add a "Channels and stability" section that explicitly states NanoClaw
   ships a single channel today, distinguishes latest/stable/pinned for
   consumers, and reserves space for a future pre-release channel without
   inventing structure that does not yet exist. Folds the previous Pinning
   section into the new structure as the Pinned bullet.
The "For detailed release notes, see the full changelog on the
documentation site" line pointed at a docs portal that does not exist.
CHANGELOG.md is the canonical record, so the header now says only what
is true: all notable changes are documented in this file.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR: Docs Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant