diff --git a/CHANGELOG.md b/CHANGELOG.md index ed235c033..1168ac5cf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog -## [0.3.0] — unreleased +## [0.3.0] — 2026-11-17 ### Breaking changes and migration diff --git a/docs/dev/plans/2026-11-15-v0.3-release-checklist.md b/docs/dev/plans/2026-11-15-v0.3-release-checklist.md index 466753295..38f30b4be 100644 --- a/docs/dev/plans/2026-11-15-v0.3-release-checklist.md +++ b/docs/dev/plans/2026-11-15-v0.3-release-checklist.md @@ -1,7 +1,8 @@ # Orcapod Python v0.3.0 — release checklist (ITL-873) -Refreshed 2026-11-17 against `metamorphic-labs` `main` at `62899bda` (replaces the -2026-11-12 checklist). Tag target: **2026-11-17 (UTC)**; release dates are UTC days. v0.3.0 is on PyPI and on +Refreshed 2026-11-17 against `metamorphic-labs` `main` at `d92e8b8f` (replaces the +2026-11-12 checklist). Tag target: **2026-11-17 (UTC)**; release dates are UTC days. +v0.3.0 is on PyPI and on `nauticalab/orcapod-python` before the workshop on **2026-11-19**. The procedure is `RELEASING.md`; this file is its v0.3.0 instance. @@ -12,9 +13,13 @@ D = developer, C = coordinator, A = agent (release PR worker). ## 1. Steps -The remaining order is fixed: every v0.3.0 pull request has merged and the fold (phase B) -is done; then the dating commit, then the freeze commit as the release PR's **last** commit, -then D tags (through the Release workflow, step 12). +The release PR #329 merged on 2026-11-17 (squash, `main` `d92e8b8f`) with the fold and +the upgrade notes but without step 7's two commits; they are the follow-up pull request +(branch `eywalker/itl-873-v030-date-and-freeze`). The remaining order is fixed: the dating +commit; once the README rewrite (ITL-1180) has merged, `main` is merged into the follow-up +PR; then the freeze commit as that PR's **last** commit; D merges it, then D tags (through the +Release workflow, step 12). Until the freeze is on `main`, `main` is not releasable: the +Release workflow's golden check stops. | # | Step | Who | Status (2026-11-17) | |---|---|---|---| @@ -24,10 +29,10 @@ then D tags (through the Release workflow, step 12). | 3 | Upgrade notes `#### Upgrading from 0.2.0` drafted from the fragments (the draft file, consumed and deleted in step 6) | A drafts, D reviews | done: every fragment on `62899bda`; now in `CHANGELOG.md` | | 4 | **ITL-946 merges** (golden-file protection: golden files per data context folder, append-only revision history in `v1.json`, release pins in `released_manifests.json`, CI tag check, `generate_golden_hashes.py --add` / `--release`; `RELEASING.md` *Before You Cut* step 2) | D merges, C tracks | done: #399, `main` `4dd015a4` | | 5 | **The last PRs before the fold merge**: ITL-1154 (#406, v1 hash definition; regenerated golden values of the unreleased `v1`), ITL-1160 (#409), ITL-1162 (#408), then ITL-1169 (#410 cleanup, #411 `superpowers/` to `docs/dev/`); merge `main` into #329 after them and `git mv` this file and the draft to `docs/dev/plans/` (fix the path in `RELEASING.md`) | D merges, C tracks | done: #406, #409, #408, #410, #411 (`main` `62899bda`, merged into #329); this file in `docs/dev/plans/`, `RELEASING.md` names it there | -| 6 | **Phase B, fold**: `uv run python scripts/assemble_changelog.py --version 0.3.0`; insert the upgrade notes at the head of *Breaking changes and migration*; move each bullets-only fragment block, text unchanged, directly under its category, before its first `####` entry (in *Breaking changes*: `#### Upgrading from 0.2.0`, then `#### Other breaking changes` with those bullets, then the detailed entries), checked by comparing the sorted non-blank lines before and after the move (one added line, that heading); delete the draft file; commit `CHANGELOG.md` with the deleted fragments. The heading stays `## [0.3.0] — unreleased` until step 7 | A, on C's signal after step 5 | done 2026-11-17 on `main` `62899bda`: 90 fragments folded, 85 blocks moved, sorted-lines check shows the one added heading only | -| 7 | **Dating commit, then freeze commit**, the release PR's last two commits, on C's go with the date. (a) Set the heading to `## [0.3.0] — YYYY-MM-DD`, the UTC day D tags. (b) `TZ=UTC uv run python tests/test_hashing/golden/generate_golden_hashes.py --release 0.3.0` (`RELEASING.md`, *Before You Cut*, step 2): appends the release revision, dated by the local clock (hence `TZ=UTC`), to the `golden` history of `src/orcapod/contexts/data/v1.json`, writes its digest under `releases` in `src/orcapod/contexts/released_manifests.json`, and, as v1's first release, sets `released_in` and the `manifest` pin. It computes no hash and rewrites no golden file. Before committing, check that the revision's date equals the heading's. **The Release workflow refuses a release without it** (`scripts/check_golden_tags.py --release-version 0.3.0` in the build job, which also fails if a golden file was added after the release revision). After it, a released golden value never changes; any change needs a `v2` context | A prepares, **D approves** | waiting for step 6 | -| 8 | CI green and the in-PR CodeRabbit review at the final head (one signed `@coderabbitai review`; every thread answered). The CodeRabbit CLI loop is dropped for v0.3.0 (D, 2026-11-16, budget) | A | per head; see the PR comments | -| 9 | Release PR marked ready and merged on `metamorphic-labs` | D | | +| 6 | **Phase B, fold**: `uv run python scripts/assemble_changelog.py --version 0.3.0`; insert the upgrade notes at the head of *Breaking changes and migration*; move each bullets-only fragment block, text unchanged, directly under its category, before its first `####` entry (in *Breaking changes*: `#### Upgrading from 0.2.0`, then `#### Other breaking changes` with those bullets, then the detailed entries), checked by comparing the sorted non-blank lines before and after the move (one added line, that heading); delete the draft file; commit `CHANGELOG.md` with the deleted fragments. The heading stays `## [0.3.0] — unreleased` until step 7 | A, on C's signal after step 5 | done 2026-11-17 on `main` `62899bda`: 90 fragments folded, 85 blocks moved, sorted-lines check shows the one added heading only; on `main` with #329 (`d92e8b8f`) | +| 7 | **Dating commit, then freeze commit**, in the follow-up PR (#329 merged without them), on C's go. (a) Set the heading to `## [0.3.0] — YYYY-MM-DD`, the UTC day D tags. (b) `TZ=UTC uv run python tests/test_hashing/golden/generate_golden_hashes.py --release 0.3.0` (`RELEASING.md`, *Before You Cut*, step 2): appends the release revision, dated by the local clock (hence `TZ=UTC`), to the `golden` history of `src/orcapod/contexts/data/v1.json`, writes its digest under `releases` in `src/orcapod/contexts/released_manifests.json`, and, as v1's first release, sets `released_in` and the `manifest` pin. It computes no hash and rewrites no golden file. Before committing, check that the revision's date equals the heading's. **The Release workflow refuses a release without it** (`scripts/check_golden_tags.py --release-version 0.3.0` in the build job, which also fails if a golden file was added after the release revision). After it, a released golden value never changes; any change needs a `v2` context | A prepares, **D approves** | (a) dating commit prepared 2026-11-17 (`2026-11-17`); (b) waits for C's go, after ITL-1180 | +| 8 | CI green on the follow-up PR. No CodeRabbit review is requested for it (D, 2026-11-17: no code changes); a review that runs by itself is handled for factual errors only. #329 had the in-PR CodeRabbit review; the CLI loop is dropped for v0.3.0 (D, 2026-11-16, budget) | A | | +| 9 | Release PR #329 merged on `metamorphic-labs`, then the follow-up PR (step 7) | D | #329 merged 2026-11-17 at `095aca3e` (`main` `d92e8b8f`); follow-up PR to open | | 10 | Pre-push checklist (section 3) | D (A can verify on request) | | | 11 | Fast-forward push of `main` to `nauticalab` (`RELEASING.md`, *Cutting a Release*, step 1). Never a squash, never a tag | D only | | | 12 | D tags: *Actions → Release → Run workflow* on `nauticalab`, version `0.3.0`, branch `main`. **Never create the tag by hand** | D only | | @@ -35,7 +40,7 @@ then D tags (through the Release workflow, step 12). | 14 | Fetch the tag back: `git fetch nauticalab --tags`, `git push origin v0.3.0` | D | | | 15 | After: complete the Linear release by hand (its jobs are skipped on `nauticalab`), notices, follow-ups (migration tool ITL-913, ITL-914, ITL-1048) | D | | -## 2. Pull requests that landed before the fold +## 2. Pull requests in the release | PR | Issue | Fragment | Hash or golden change | Status | |---|---|---|---|---| @@ -52,6 +57,8 @@ then D tags (through the Release workflow, step 12). | #408 | ITL-1162, ITL-1164 | `changelog.d/ITL-1162.md` | none | merged | | #410 | ITL-1169 | none | none (repository cleanup; `design_issues/` to `docs/dev/design_issues/`) | merged | | #411 | ITL-1169 | none | none (`superpowers/` to `docs/dev/`) | merged | +| #329 | ITL-873 | none (it folds them) | none | merged (without step 7) | +| to open | ITL-1180 | C says | none (README rewrite; replaces the file, including #329's two edits) | before the freeze | Not in v0.3.0 unless D says otherwise: #385 (ITL-1062), #359, #357, #342 (ITL-1023, referential tags, v0.4), #341, #294 (dependency bump), #258 (ITL-611 older PR; ITL-611 @@ -80,7 +87,7 @@ Also from *One-time setup* in `RELEASING.md` (D only, not verifiable by an agent naming owner `nauticalab`, repository `orcapod-python`, workflow `release.yml`, `main` protected on `nauticalab`, and `v*` tag protection on both repositories (step 0). -## 4. Release PR contents (#329) +## 4. Release PR contents (#329 and the follow-up PR) - `CHANGELOG.md`: the folded `## [0.3.0]` section with the upgrade notes at its head and bullets-only entries above the detailed ones (step 6); dated in step 7. @@ -89,8 +96,8 @@ protected on `nauticalab`, and `v*` tag protection on both repositories (step 0) `0.1.4` and points to *Upgrading from 0.2.0*. - `RELEASING.md`: as on `main` (ITL-946's release step), plus this checklist's name, and release dates are UTC days: the freeze runs with `TZ=UTC`. -- Last two commits: the dating commit and the data context freeze (step 7), after D's - approval. +- The follow-up PR: the dating commit and the data context freeze (step 7, the last commit), + after D's approval. ## 5. Evidence log @@ -119,3 +126,6 @@ protected on `nauticalab`, and `v*` tag protection on both repositories (step 0) per-release checklist line, resolved to `docs/dev/plans/` naming both checklists. Phase B done: 90 fragments folded, upgrade notes inserted, 85 bullets-only blocks moved; the result equals the dry run of `b2ff71bc` but for the undated heading. +- 2026-11-17: D merged #329 at `095aca3e` (squash, `main` `d92e8b8f`) before step 7. The + follow-up PR carries the dating commit (`## [0.3.0] — 2026-11-17`, UTC) and then the + freeze. diff --git a/src/orcapod/contexts/data/v1.json b/src/orcapod/contexts/data/v1.json index ff9ce885d..53f74214b 100644 --- a/src/orcapod/contexts/data/v1.json +++ b/src/orcapod/contexts/data/v1.json @@ -2,7 +2,7 @@ "context_key": "std:v1:default", "version": "v1", "description": "Data context of Orcapod v0.3: the hashing generation H1. Frozen when v0.3.0 is released, except its golden history, which only grows; editable in place while that release is prepared.", - "released_in": null, + "released_in": "0.3.0", "previous": "std:v0.1:default", "file_hasher": { "_class": "orcapod.hashing.file_hashers.FileHasher", @@ -242,6 +242,13 @@ }, "previous": null, "digest": "0a789cf9e8d1df9fb762d6dc2fabffcd3383cd6a21ef147e8c6583f963280c2e" + }, + { + "date": "2026-11-17", + "release": "0.3.0", + "added": {}, + "previous": "0a789cf9e8d1df9fb762d6dc2fabffcd3383cd6a21ef147e8c6583f963280c2e", + "digest": "6cdd29cdc6fa98df322931e2ab0ff9df151fdb47d3381adecd9f58fd55d2fb22" } ] }, diff --git a/src/orcapod/contexts/released_manifests.json b/src/orcapod/contexts/released_manifests.json index 49ff26e31..3c0362ab0 100644 --- a/src/orcapod/contexts/released_manifests.json +++ b/src/orcapod/contexts/released_manifests.json @@ -1,6 +1,8 @@ { "v1": { - "manifest": null, - "releases": {} + "manifest": "18e7c15a446014b3e6a3178bb5daf331774f8a5214006bec40fc80442c08da09", + "releases": { + "0.3.0": "6cdd29cdc6fa98df322931e2ab0ff9df151fdb47d3381adecd9f58fd55d2fb22" + } } }