Skip to content

docs(release): v0.1.0 changelog + explicit rc-tag publish policy#57

Merged
jamesarich merged 2 commits into
mainfrom
release/v0.1.0-prep
Jul 17, 2026
Merged

docs(release): v0.1.0 changelog + explicit rc-tag publish policy#57
jamesarich merged 2 commits into
mainfrom
release/v0.1.0-prep

Conversation

@jamesarich

Copy link
Copy Markdown
Collaborator

Summary

Release-prep for v0.1.0 (refs #53): promotes the CHANGELOG [Unreleased] section to [0.1.0] — 2026-07-16, and makes the release workflow's rc-tag behavior explicit (dispatch-only) instead of silently ignoring -rcN tags.

Merge this last — after the Renovate batch and #52 land — so the 0.1.0 section reflects everything that ships. If dependency bumps merge before tagging, a build: line can be added under Changed. Bump the section date if tagging slips past 2026-07-16.

Type of change

  • Bug fix (non-breaking)
  • New feature (non-breaking)
  • Breaking change (will require a SemVer-MINOR pre-1.0 / SemVer-MAJOR post-1.0 bump)
  • Documentation only
  • Infrastructure / CI / build
  • Proto submodule bump
  • ADR (Architecture Decision Record)

Related issue / discussion

Refs #53 (checklist items: finalize CHANGELOG, rc-tag pattern decision).

What's in here

CHANGELOG.md

  • [Unreleased][0.1.0] — 2026-07-16; fresh empty [Unreleased] above it.
  • The old [0.1.0] — 2026-05-01 section is retitled [0.1.0-rc1], matching the only tag that actually exists. Nothing was ever published, so v0.1.0 ships everything; the new section documents the rc1 → final delta with a preamble saying so.
  • Breaking preamble rewritten: explains why breaking changes ship in 0.1.0 rather than a 0.2.0 MINOR (no published consumer exists).

release.yml + docs/release-runbook.md — rc-tag policy (decision proposed here)

  • Keep the tag-push trigger stable-only and document rc releases as workflow_dispatch-only, rather than widening the pattern to v[0-9]+.[0-9]+.[0-9]+-rc[0-9]+. Rationale: Maven Central is immutable, so rc publishes should be an explicit act; and axion's resolution of -rcN tags is unverified here (the verify-version step would guard a dispatch run either way). If you'd rather have rc tags auto-publish, it's a one-line pattern addition — say the word and I'll flip it.
  • Runbook fixes while in there: dropped the stale "all workflows are .yml.disabled" note (ci/release/docs are live), git tag -agit tag -s (signed tags, per the workflow header and Cut the first release (v0.1.0) now main is green #53), publish task name corrected to publishAndReleaseToMavenCentral (matches release.yml and docs/ci-cd.md).

Affirmations

  • All commits are signed off (DCO — git commit -s).
  • I have read CONTRIBUTING.md.
  • If this changes the public API, I have run ./gradlew updateKotlinAbi and committed the regenerated api/*.api files. (N/A — docs/CI only)
  • If this changes wire behavior, I have updated docs/protocol.md and cited firmware / sibling-app sources for verification. (N/A)
  • If this is a non-trivial design change, I have added or updated an ADR under docs/decisions/. (N/A)
  • I have run ./gradlew check locally and it passes. (docs/workflow-comments only; no build-affecting change)

How was this verified?

Docs-only + workflow comments and a dispatch input description; no functional workflow change (trigger pattern untouched). Verified the corrected task name against docs/ci-cd.md and release.yml.

Notes for reviewers

Prepared with Claude Code as part of working #53. The one policy decision embedded here is rc-tags-as-dispatch-only — flag if you want auto-publishing rc tags instead.

🤖 Generated with Claude Code

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@jamesarich, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 33 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a7c21c35-ba9b-4d14-80c6-f02d845ddf5b

📥 Commits

Reviewing files that changed from the base of the PR and between 7e96cf9 and 59b43c5.

📒 Files selected for processing (3)
  • .github/workflows/release.yml
  • CHANGELOG.md
  • docs/release-runbook.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

jamesarich and others added 2 commits July 16, 2026 19:39
Promote [Unreleased] to [0.1.0] — 2026-07-16 and retitle the 2026-05-01
section to [0.1.0-rc1], matching the only tag that actually exists. The
rc1 tag was an internal team-share and never published, so v0.1.0 ships
everything; the [0.1.0] section documents the rc1 → final delta and the
Breaking preamble now explains why these ship in 0.1.0 rather than a
MINOR bump.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>
…e workflows

The release workflow's tag pattern v[0-9]+.[0-9]+.[0-9]+ never matched
-rcN suffixes, so pushing v0.1.0-rc1 silently published nothing. Keep
stable-only auto-publish (Maven Central is immutable; rc publishes
should be explicit) and document the workflow_dispatch path for rcs, in
release.yml comments and a new runbook section.

Also drop the stale 'all workflows are .yml.disabled' runbook note
(ci/release/docs workflows are live), align the tag command with the
signed-tag convention (-s), and correct the publish task name to
publishAndReleaseToMavenCentral per docs/ci-cd.md.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>
@jamesarich
jamesarich force-pushed the release/v0.1.0-prep branch from fea159b to 59b43c5 Compare July 17, 2026 00:39
@jamesarich
jamesarich merged commit e089e1d into main Jul 17, 2026
18 of 19 checks passed
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.

1 participant