Skip to content

Stop committing generated qe-version.ts (gitignore it like version.ts) - #90

Merged
mmcky merged 2 commits into
mainfrom
chore/qe-version-untracked
Aug 14, 2026
Merged

Stop committing generated qe-version.ts (gitignore it like version.ts)#90
mmcky merged 2 commits into
mainfrom
chore/qe-version-untracked

Conversation

@mmcky

@mmcky mmcky commented Aug 14, 2026

Copy link
Copy Markdown

Resolves #87 by taking the issue's second option: stop committing the generated file.

packages/mystmd/src/qe-version.ts is regenerated by copy:qe-version on every path that consumes it (build, lint, lint:format, test), and the package already gitignores its other generated file, src/version.ts, on exactly this pattern — committing qe-version.ts was the inconsistency. Untracking it removes the stale-contradiction failure mode permanently (there is no committed copy to go stale) and ends the spurious git status modification that every build produced.

Verified after untracking: bun run build in packages/mystmd regenerates the file and myst --version still reports v1.10.1 (qe-v9); a checkout without the file builds cleanly since copy:qe-version runs before tsc.

No changeset: nothing published changes — the file is generated at build time either way.

🤖 Generated with Claude Code

quantecon/VERSION.yml said qe-v9 while the committed generated file still
said qe-v8 — the qe-v9 cut updated the source of truth without regenerating
the derived file. Rather than adding a regeneration step to the version-cut
checklist, stop tracking the file: every consuming script (build, lint,
test) already runs copy:qe-version first, and the package's other generated
file, src/version.ts, is already gitignored on exactly this pattern. This
also ends the spurious working-tree modification every build produced.

Fixes #87.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings August 14, 2026 00:21

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Removes the tracked packages/mystmd/src/qe-version.ts file and instead treats it as a generated artifact (matching the existing approach for src/version.ts), eliminating stale committed state and avoiding persistent post-build working-tree dirtiness (Issue #87).

Changes:

  • Delete the committed generated file packages/mystmd/src/qe-version.ts.
  • Add src/qe-version.ts to packages/mystmd/.gitignore so it’s no longer tracked and won’t reappear in commits.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
packages/mystmd/src/qe-version.ts Removes the committed generated QE version file so it can’t go stale vs quantecon/VERSION.yml.
packages/mystmd/.gitignore Ignores src/qe-version.ts (consistent with src/version.ts) to prevent re-tracking.

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

@mmcky
mmcky merged commit b0e7efc into main Aug 14, 2026
8 of 11 checks passed
@mmcky
mmcky deleted the chore/qe-version-untracked branch August 14, 2026 01:21
mmcky added a commit that referenced this pull request Aug 14, 2026
qe_version -> qe-v10; feature 15 (a40f0cb) tagged qe-v10. Tag to be
cut on this PR's merge commit per the VERSION.yml procedure, so the
tagged tree is self-consistent. qe-v10 = qe-v9 + heading attribute
blocks + the qe-version.ts untracking housekeeping (#90, no feature row).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
mmcky added a commit that referenced this pull request Aug 14, 2026
…ta (#91)

* chore(quantecon): track PR #89 (heading-attributes) in fork trackers

VERSION.yml gains feature 15 (merge_sha a40f0cb, tag null until the
next qe-v cut); UPSTREAM-PRS.yml gains a standalone heading-attributes
candidate — it completes upstream's inline-attribute mechanism (their
jupyter-book#1822) and touches no fork-modified code paths, so the cherry-pick
should be clean. Downstream adoption is tracked in
QuantEcon/claude-latex-to-myst#160 and needs a qe-v10 tag first.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* chore(quantecon): cut qe-v10 metadata (heading-attributes)

qe_version -> qe-v10; feature 15 (a40f0cb) tagged qe-v10. Tag to be
cut on this PR's merge commit per the VERSION.yml procedure, so the
tagged tree is self-consistent. qe-v10 = qe-v9 + heading attribute
blocks + the qe-version.ts untracking housekeeping (#90, no feature row).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5 <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.

qe-version.ts committed at qe-v8 while VERSION.yml says qe-v9 (generated file not regenerated on the version cut)

2 participants