Skip to content

Release version 0.22.1 - #464

Merged
mmcky merged 1 commit into
mainfrom
release/v0.22.1
Oct 9, 2026
Merged

mmcky merged 1 commit into
mainfrom
release/v0.22.1

Conversation

@mmcky

@mmcky mmcky commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Bumps __version__ to 0.22.1 and moves the Unreleased CHANGELOG entries under ## [0.22.1] - 2026-10-09, with the compare links updated. It has the same shape as the 0.22.0 release commit (e3611b4).

What's in it

Change PR Effect for sites using the theme
View Source button left out where there is no repository URL (#384) #453 Generated pages (genindex, search, prf-prf) no longer link to None. Sites that set no repository_url no longer show the toolbar's GitHub icon at all
sphinx-book-theme.js no longer requested (#454) #455 The 404 on every page goes away. Nothing else changes, because the script never loaded
Theme assets compiled on Node.js 24.21.0 #445 Compiled CSS and JS are byte-identical. Building from source now needs a platform with a Node 24 binary
/update-snapshots regenerates all baselines again #456 CI only
Visual baselines refreshed #457 Tests only; no CHANGELOG entry

Together, #453 and #455 clear the only missing link targets an offline link check of lecture-jax turned up. The lecture series pick the fix up through their usual dependabot bump once this is on PyPI.

Why a patch release

Both user-facing changes are contained fixes, and the asset build is byte-identical, so by this repo's practice (minor for changes that ask downstream books to re-verify snapshots) this is 0.22.1. The one visible change is the GitHub icon leaving the toolbar on sites with no repository_url. The QuantEcon lecture sites all set it, so for them the only visible difference is on generated pages. If you'd rather flag that change with 0.23.0, say so and I'll redo the bump.

Checks

  • Full suite passes on this branch: 227 tests on Python 3.12 + Sphinx 7.4.7 and Python 3.13 + Sphinx 8.2.3.
  • quantecon_book_theme.__version__ reports 0.22.1.
  • pre-commit passes.
  • main is green at 554546d, including the visual job (103 passed, 0 flaky).
  • Known flaky test: Visual tests flaky on math pages: MathJax can size math before the web font loads #463 (math pages sometimes render at a different height in the visual job). If visual fails here on a math page's size, that's the likely cause; a re-run usually clears it.

After merging

Tag the squash-merge commit on main, not this branch's commit. The tag push runs the publish job in tests.yml, which only uploads to PyPI after pre-commit and tests pass on the tag.

git switch main && git pull --ff-only
git tag -a v0.22.1 -m "Version 0.22.1 - View Source and sphinx-book-theme.js link fixes"
git push origin v0.22.1

Then create the GitHub release, using the 0.22.1 CHANGELOG section as the notes:

awk '/^## \[0\.22\.1\]/{f=1;next} /^## \[/{f=0} f' CHANGELOG.md > /tmp/v0.22.1-notes.md
gh release create v0.22.1 --title "v0.22.1" --notes-file /tmp/v0.22.1-notes.md --latest --verify-tag

The CHANGELOG date is 2026-10-09. If the tag goes out on a later day, update the date before merging.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings October 9, 2026 04:20
@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

@codecov

codecov Bot commented Oct 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@554546d). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #464   +/-   ##
=======================================
  Coverage        ?   59.48%           
=======================================
  Files           ?        2           
  Lines           ?      548           
  Branches        ?        0           
=======================================
  Hits            ?      326           
  Misses          ?      222           
  Partials        ?        0           
Flag Coverage Δ
pytests 59.48% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The release content is correct, but the publish step tags PyPI and the date is tied to the actual tag day, so a human should confirm timing/semver before this ships.

0 open findings

What changed in this PR

This is a routine release PR that cuts version 0.22.1 of the quantecon-book-theme Sphinx theme. It bumps the package version and promotes the accumulated [Unreleased] CHANGELOG entries into a dated 0.22.1 section, following the same shape as the previous 0.22.0 release. The release bundles two user-facing bug fixes (#453 "View Source" no longer links to None, #455 the missing sphinx-book-theme.js 404), a build-tooling change (#445 Node 24 compile), and a CI change (#456), making them available to downstream lecture sites via PyPI.

Changes:

  • Bump __version__ from 0.22.0 to 0.22.1 in src/quantecon_book_theme/__init__.py.
  • Insert a ## [0.22.1] - 2026-10-09 CHANGELOG section (emptying [Unreleased]) and update the compare-link footer ([Unreleased], add [0.22.1]).
File Description
src/​quantecon_book_theme/​__init__.py Updates the single source-of-truth version string consumed by sphinx_theme_builder (pyproject uses dynamic = ["version"]).
CHANGELOG.md Adds the dated 0.22.1 release section with the existing Changed/Fixed/CI entries and updates the semantic-version compare links.

Verification notes:

  • Version bump is the only place needing a change — pyproject.toml declares dynamic = ["version"], and grep found no other hardcoded 0.22.0 references outside the CHANGELOG.
  • CHANGELOG structure matches the established convention (new dated header inserted directly under an emptied [Unreleased], as done for 0.22.0).
  • The release date 2026-10-09 equals today's date, so it is not a future date.
  • Compare links are internally consistent: [Unreleased] now points to v0.22.1...HEAD, the new [0.22.1] link spans v0.22.0...v0.22.1, and the prior links are unchanged.
  • The patch-vs-minor version choice was explicitly raised by the author and left to the reviewer; this is a subjective judgment the repo treats as a patch, so no objective issue is raised.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

🎭 Visual Regression Test Results

passed  103 passed
skipped  3 skipped

Details

stats  106 tests across 1 suite
duration  3 minutes, 51 seconds
commit  6b88b53

Skipped tests

desktop-chrome › theme.spec.ts › Visual Regression Tests › prob-matrix - full page screenshot
mobile-chrome › theme.spec.ts › Visual Regression Tests › prob-matrix - full page screenshot
mobile-chrome › theme.spec.ts › Theme Features › f-string interpolation styling

@mmcky
mmcky merged commit e8d04b6 into main Oct 9, 2026
13 checks passed
@mmcky
mmcky deleted the release/v0.22.1 branch October 9, 2026 04:32

This branch was successfully deployed

1 active deployment
pull request — 6b88b537 Deployed Oct 9, 2026 by github-actions[bot]
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.

2 participants