ci: lint docs/assets/scripts in make lint and CI#53
Merged
Conversation
The figure generator scripts added in #42 were ruff-clean but nothing enforced it. Add a root-level ruff.toml as the authoritative config for scripts outside the packages (mirroring the shared per-package config), hook docs/assets/scripts into the root lint/format targets via core's venv, and add a docs-scripts CI job that runs ruff check + format --check with a dev-only sync of core. Closes #43
Member
|
LGTM. Verified the mechanics hold: ruff is in core's Two non-blocking notes:
|
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
ruff.tomlas the authoritative ruff config for scripts outside the packages, mirroring the identical[tool.ruff]config every package already declaresdocs/assets/scripts/into the rootmake lint/make formattargets, running ruff via core's venvdocs-scriptsCI job runningruff check+ruff format --checkon the scripts, with a lightweightuv sync --only-group devof core (no torch install)Closes #43
Test Plan
make lintpasses end-to-end, including the newdocs/assets/scriptsstepI001), proving the rootruff.tomlis discovered — the isort rule is not in ruff's defaultspyproject.tomlconfig is closer and wins)uv sync --only-group dev+uv run --project core --no-sync ruff ...)