chore(quantecon): add VERSION.yml as build identifier + upstream tracker#24
Merged
Conversation
Records which QuantEcon-specific features are merged into this fork's main, identified by a `qe-vN` tag that also exists as a git tag on the corresponding squash-merge commit. Doubles as a tracker for upstream PR status — each feature has an `upstream` block that fills in as features get upstreamed to jupyter-book/mystmd. Populated with the two features already on main: - qe-v1: feature/myst-to-ipynb (#16) - qe-v2: feature/book-numbering (#22) Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds a QuantEcon fork build identifier and documents how it should be maintained for tracing which fork-specific features are present in lecture builds.
Changes:
- Adds
quantecon/VERSION.ymlwith current QuantEcon feature/version metadata. - Documents the version/tag maintenance workflow in
quantecon/README.md. - Updates
quantecon/.gitignoreto allow trackingVERSION.yml.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
quantecon/VERSION.yml |
Adds the diagnostic build/version tracker and upstream status queue. |
quantecon/README.md |
Documents the purpose and update workflow for VERSION.yml. |
quantecon/.gitignore |
Allows VERSION.yml to be committed from the scratch directory. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
quantecon/VERSION.ymlrecording which QuantEcon-specific features are in this fork'smainqe_versionfield matches a git tag of the same name on the corresponding squash-merge commitupstreamblock that tracks the eventual upstream PR status —VERSION.ymldoubles as the upstreaming queue.gitignoreto allowVERSION.ymlpast the scratch-space filterREADME.mdAlready populated
a045d57d— feature/myst-to-ipynb (feat(ipynb): CommonMark ipynb export + image attachment embedding #16)032957c2— feature/book-numbering (Book-style numbering: format, label, section-tagged TOC, auto-prefix #22)Both tags already pushed to origin.
Audience
Diagnostics for QuantEcon lecture builds. Not a release version, not intended for broader distribution. Lecture CI can
cat quantecon/VERSION.ymlto log which fork state was used in a build — useful for debugging "this lecture broke, what features did it have".Test plan
cat quantecon/VERSION.ymlreturns the expected content after mergegit tag -l 'qe-v*'showsqe-v1andqe-v2🤖 Generated with Claude Code