-
Notifications
You must be signed in to change notification settings - Fork 0
feat: add QSL version control CLI #159
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # QSL version control plane | ||
|
|
||
| QuantRuntimeSettings is the control plane for QuantStrategyLab internal version | ||
| management. | ||
|
|
||
| ## Source of truth | ||
|
|
||
| - `compat/bundles/*.toml` is the source of truth for internal repository commit pins. | ||
| - Each consumer repository declares its bundle in `qsl.toml`. | ||
| - Consumer files (`pyproject.toml`, `uv.lock`, `requirements.txt`, `constraints.txt`) must match the declared bundle. | ||
| - `internal_dependency_matrix.json` is generated from local consumer dependency files; do not hand-edit it except for emergency repair. | ||
|
|
||
| ## CLI | ||
|
|
||
| Use `qslctl` for repository and workspace checks: | ||
|
|
||
| ```bash | ||
| python3 python/scripts/qslctl.py check --repo-root ../UsEquityStrategies | ||
| python3 python/scripts/qslctl.py check-all --projects-root /Users/lisiyi/Projects | ||
| python3 python/scripts/qslctl.py report --projects-root /Users/lisiyi/Projects | ||
| python3 python/scripts/qslctl.py plan --projects-root /Users/lisiyi/Projects | ||
| python3 python/scripts/qslctl.py generate-matrix --projects-root /Users/lisiyi/Projects --check | ||
| python3 python/scripts/qslctl.py generate-matrix --projects-root /Users/lisiyi/Projects --sync | ||
| ``` | ||
|
|
||
| ## Rollout policy | ||
|
|
||
| 1. Create or update a bundle in `compat/bundles/`. | ||
| 2. Apply that bundle by ring: core → strategy libraries → pipelines/research → runtime platforms → ops/tooling. | ||
| 3. Regenerate `internal_dependency_matrix.json` after consumer pins are updated. | ||
| 4. Keep strict checks enabled only after a ring is converged. | ||
|
|
||
| ## Workspace report / plan | ||
|
|
||
| - `qslctl report` is read-only. It groups the current workspace by ring, status, and bundle hotspot. | ||
| - `qslctl plan` is read-only. It renders the ring-by-ring convergence order and highlights which repos should be fixed before the next ring starts. | ||
| - Use `report` to answer “what is broken right now?” and `plan` to answer “what should we fix first?” |
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When an internal dependency appears only in its
[[package]]stanza inuv.lock(for example a transitive locked package hasname = "..."followed bysource = { git = "https://github.com/QuantStrategyLab/..." }on the next line), this pattern never matches because it requiresnameandgiton the same line. That meansgenerate-matrixand matrix checks ignore those locked QSL refs unless they are also repeated in[package.metadata].requires-dist, allowing transitive internal pins inuv.lockto drift without being reported.Useful? React with 👍 / 👎.