Skip to content

chore: drop Changesets for manual changelog + tag flow; rename to @quantecon/lecture-theme#72

Merged
mmcky merged 1 commit into
mainfrom
chore/drop-changesets
Jun 5, 2026
Merged

chore: drop Changesets for manual changelog + tag flow; rename to @quantecon/lecture-theme#72
mmcky merged 1 commit into
mainfrom
chore/drop-changesets

Conversation

@mmcky
Copy link
Copy Markdown
Contributor

@mmcky mmcky commented Jun 5, 2026

Addresses #71 (focused scope — see "Out of scope" below).

Completes the Phase 0 decision in PLAN.md to drop Changesets in favour of a curated Keep a Changelog + git tags. Changesets' generated changelog clashed with our hand-curated CHANGELOG.md, and the bot kept regenerating the stale "Version Packages" PR (#69).

What changed

  • Remove Changesets wiring
    • Delete .changeset/ (config + the two pending changeset files).
    • Remove the changeset and version npm scripts and the @changesets/cli devDependency.
    • Delete .github/workflows/release.yml (its only job was changesets/action).
    • package-lock.json regenerated — drops the orphaned @changesets/* subtree (2 ins / 563 del). @curvenote/ansi-to-react is an unrelated upstream dep and is untouched.
  • Preserve release notes — the two pending changesets (FOUC FOUC: brief flash of unstyled / raw HTML on every page navigation #66, security overrides chore(deps): resolve safe Dependabot advisories via overrides + triage doc #68) are migrated into a curated ## [Unreleased] section in CHANGELOG.md, so nothing is lost when .changeset/ goes away.
  • Rename package @curvenote/quantecon-book@quantecon/lecture-theme (package.json, template/package.json, CHANGELOG.md header). Pure metadata — the theme ships as a GitHub zip + template.yml, not via npm install, and is private. Forward-compatible with a future @quantecon npm org (valid now precisely because it's never published).
  • DocsCONTRIBUTING.md "Releases" now documents the manual bump → changelog → tag flow.

Versioning

Version stays 2.0.0; the migrated entries sit under ## [Unreleased] and get dated/bumped to 2.0.1 when a release is actually cut (decided with maintainer).

Verification

  • npm install --package-lock-only — lock diff is only the name change + @changesets/* removal; no unrelated churn.
  • npm run compile — typecheck passes (header now reads @quantecon/lecture-theme@2.0.0).
  • No @changesets / changeset references remain in package.json, package-lock.json, or .github/.
  • Only @curvenote/ansi-to-react (a real dependency) remains under the @curvenote name.

Out of scope (follow-up for the rest of #71)

  • The tag-triggered build → zip → GitHub Release pipeline (adapt upstream theme-assets.yml).
  • Retiring make deploy, consumer migration (lecture-wasm), archiving the old bundle repo.
  • Reserving the @quantecon npm org (separate org-admin task).

After merge

Close the now-obsolete Changesets "Version Packages" PR #69.

🤖 Generated with Claude Code

…antecon/lecture-theme

Completes the Phase 0 decision (PLAN.md) to drop Changesets in favour of a
curated Keep a Changelog + git tags, since the generated changelog clashed
with the hand-curated one and the bot kept regenerating the "Version
Packages" PR.

- Remove Changesets wiring: delete .changeset/, the changeset/version npm
  scripts, the @changesets/cli devDependency, and .github/workflows/release.yml
  (its only job was running changesets/action). Lockfile regenerated (drops the
  orphaned @changesets subtree; @curvenote/ansi-to-react is an unrelated real
  dep and is untouched).
- Migrate the two pending changesets (FOUC #66, security overrides #68) into a
  curated CHANGELOG.md "## [Unreleased]" section so no release notes are lost.
- Rename the package @curvenote/quantecon-book -> @quantecon/lecture-theme
  (package.json, template/package.json, CHANGELOG header). Pure metadata: the
  theme is distributed as a GitHub zip + template.yml, not via npm install, and
  the package is private. Forward-compatible with a future @QuantEcon npm org.
- Rewrite CONTRIBUTING.md "Releases" to document the manual bump -> changelog
  -> tag flow.

Focused scope: the tag-triggered build->zip->GitHub Release pipeline is a
deliberate follow-up. Interim releases continue via make deploy.

Addresses #71. The stale "Version Packages" PR #69 becomes obsolete and will
be closed after this merges.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 5, 2026 05:21
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR completes the Phase 0 decision to remove Changesets and move to a manual Keep a Changelog + git-tag release flow, while also renaming the package metadata to @quantecon/lecture-theme to match QuantEcon ownership/branding.

Changes:

  • Removed Changesets integration (workflow + config files) and stripped changeset/version scripts and @changesets/cli from the Node setup.
  • Migrated the two pending Changesets entries into CHANGELOG.md under a curated ## [Unreleased] section.
  • Renamed package metadata across package.json, template/package.json, and package-lock.json to @quantecon/lecture-theme, and updated release documentation in CONTRIBUTING.md.

Reviewed changes

Copilot reviewed 9 out of 10 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
template/package.json Renames template package metadata to @quantecon/lecture-theme.
package.json Removes Changesets scripts/dependency; renames package to @quantecon/lecture-theme.
package-lock.json Lockfile regenerated to reflect removal of @changesets/* tree and package rename.
CONTRIBUTING.md Updates release docs to a manual changelog + tag workflow.
CHANGELOG.md Adds curated ## [Unreleased] section and updates package name in header text.
.github/workflows/release.yml Removes the Changesets-based release workflow.
.changeset/config.json Removes Changesets configuration.
.changeset/README.md Removes Changesets documentation stub.
.changeset/fouc-critical-css.md Removes pending Changesets entry (migrated to CHANGELOG.md).
.changeset/security-deps-overrides.md Removes pending Changesets entry (migrated to CHANGELOG.md).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CHANGELOG.md
@mmcky mmcky merged commit 91baf31 into main Jun 5, 2026
3 checks passed
@mmcky mmcky deleted the chore/drop-changesets branch June 5, 2026 05:42
mmcky added a commit that referenced this pull request Jun 5, 2026
Reconcile PLAN.md Phase 0 with what landed in #72 and the 2.0.0 deploy:

- Versioning & changelog: note Changesets removal/changelog migration/docs/
  PR #69 closure done in #72; remaining = the tag-triggered release.yml
  rewrite. Cross-link the live tracker #71.
- Fix stale claim that template.yml is "stale at 1.0.0" — it is 2.0.0 now,
  kept in sync with package.json manually; only the automation remains.
- Tick the interim 2.0.0 quick-deploy: package.json at 2.0.0 and shipped to
  QuantEcon/quantecon-theme as 2ca0a12 (v2.0.0 from 2cf3456).
- Naming/branding drift: package name reconciled to @quantecon/lecture-theme
  in #72; remaining is template.yml title/source pending the repo rename.

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
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