chore(release): prepare v3.0.0 - #236
Conversation
A major release: #205 replaced five `launch_*` options, so a consumer that bumps the pinned theme URL without editing `myst.yml` loses its Launch control. SemVer puts that at 3.0.0 rather than 2.8.0. `CHANGELOG.md` gains the `## [3.0.0] - 2026-09-12` heading over the nine `[Unreleased]` entries, the footer compare link, and an `[Unreleased]` base re-pointed at the new tag. `package.json` goes to 3.0.0, and README's two pinned `vX.Y.Z` URLs -- the `site.template` example and the git-metadata plugin -- follow it, which is the last outstanding criterion on #217. `template.yml` is deliberately untouched at 2.1.0: `release.yml` stamps its `version` from `package.json` into the published bundle, so the two cannot drift. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
There was a problem hiding this comment.
🟢 Approval recommended
The changes are a mechanical version/CHANGELOG/URL bump that matches the documented release steps and satisfies both release-workflow guards, with no remaining stale references.
Pull request overview
This PR prepares the v3.0.0 release, which closes the book-theme parity gate (#147). It carries the nine [Unreleased] CHANGELOG entries under a dated 3.0.0 heading and bumps the package version. The major bump is warranted by the breaking Launch-control change (#205), which removed five launch_* options in favor of the launch_notebook_* group plus launch_colab.
Changes:
- Bump package version
2.7.0→3.0.0inpackage.jsonandpackage-lock.json. - Add the
## [3.0.0] - 2026-09-12CHANGELOG heading over existing entries, add the footer compare link, and re-point[Unreleased]. - Update the two pinned
vX.Y.Zrelease URLs inREADME.md.
File summaries
| File | Description |
|---|---|
package.json |
Bumps the theme version to 3.0.0. |
package-lock.json |
Mirrors the 3.0.0 version bump in both lockfile version fields. |
CHANGELOG.md |
Adds the dated 3.0.0 section heading and compare links; leaves [Unreleased] empty. |
README.md |
Updates the git-metadata plugin URL and site.template example to the v3.0.0 pinned URLs. |
Review details
- Files reviewed: 3/4 changed files
- Comments generated: 0
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
🎭 Visual regression results
Details
Skipped testsmobile-chrome › theme.spec.ts › QuantEcon theme — visual regression › without JavaScript › drawer-opens-without-javascript |
There was a problem hiding this comment.
🔵 Needs a closer look
It initiates a high-stakes, irreversible tag-triggered release pipeline, so a maintainer should give final sign-off despite all release artifacts verifying as correct.
Review details
- Files reviewed: 3/4 changed files
- Comments generated: 0 new
- Review effort level: Balanced
The release that closes the book-theme parity gate (#147). It carries the nine
[Unreleased]entries from the eight PRs that landed on 2026-09-12.Why 3.0.0 and not 2.8.0
#205 removed five
launch_*options and replaced them with thelaunch_notebook_*group pluslaunch_colab. A consumer that bumps the pinned theme URL without editing itsmyst.ymlsilently loses its Launch control — no error, just a missing button. This repository declares SemVer adherence, and that is the case a major bump exists for.What consumers have to change
Only the launch options. Everything else in this release is additive or a fix.
launch_repo_urllaunch_notebook_repolaunch_branchlaunch_notebook_branch(defaults tomain)launch_notebooks_pathlaunch_notebook_dirlaunch_source_pathlaunch_notebook_source_dirlaunch_repo_suffixlaunch_colab: true— Launch is now opt-inA repository with no notebooks companion sets none of these and shows no Launch control, which is what it should have been doing all along: the old behaviour guessed a repository name from
project.githuband linked to it whether or not it existed.docs/migrating.md(new in this release) is the step-by-step for a repository moving off the Sphinx theme, and its Launch section covers exactly this.What is in it
Nine entries: five Added (default site footer, the
{raw}rewrite script, the migration checklist, canonical links, h4 subsections in the outline), two Changed (the breaking launch change, andPLAN.mdclosed out), three Fixed (output images centred, base-URL-aware head links, and the user docs corrected against what the theme actually does). The full text is the## [3.0.0]section ofCHANGELOG.md, whichrelease.ymluses verbatim as the release notes.The four files, and the one that is deliberately absent
CHANGELOG.md— the## [3.0.0] - 2026-09-12heading over the existing entries, the[3.0.0]footer compare link, and[Unreleased]re-pointed atcompare/v3.0.0...HEAD.package.json/package-lock.json— 2.7.0 → 3.0.0, vianpm version 3.0.0 --no-git-tag-version.README.md— both pinnedvX.Y.ZURLs, thesite.templateexample and the git-metadata plugin URL. These are the last outstanding criterion on Review the user docs against what shipped before the parity gate closes #217, which can be closed once this merges.template.ymlis untouched at 2.1.0 by design.release.ymlstamps itsversionfrompackage.jsoninto the published bundle, so bumping it here would only create a way for the two to drift. CONTRIBUTING's release steps say so explicitly.Release guards, checked before pushing
release.ymlfails after the tag exists if either guard trips, and recovery means force-moving a pushed tag, so both were verified locally:package.json— 3.0.0 ↔v3.0.0;CHANGELOG.mdhas a## [3.0.0]section, in the same## [X.Y.Z] - YYYY-MM-DDshape every previous release used, which is what the workflow'sawkextraction keys on.[Unreleased]is left empty with nothing orphaned above the new heading,tscis clean, and the unit suite passes.After merge
git tag v3.0.0 && git push origin v3.0.0That triggers
release.yml, which builds the theme, zips the bundle and publishes the GitHub Release withquantecon-theme.zipattached. I have not created the tag.🤖 Generated with Claude Code