Merged
Conversation
* The new workflow is significantly faster on my computer: ``` $ # New workflow $ uv run just tests ... real 0m11.830s user 1m31.411s sys 0m7.255s ``` ``` $ # Old workflow $ tox ... real 0m19.537s user 2m2.577s sys 0m7.972s ``` * `uv` manages installation of the appropriate versions of Python and all pip packages, greatly simplifying the creation of PyRTL development environments * This pins all developer tools to specific versions. Previously we only pinned documentation tools. This avoids confusing situations where lint errors suddenly appear just because a new version of `ruff` was released. To run all tests with the new workflow: ``` $ uv run just tests ``` To build documentation with the new workflow: ``` $ uv run just docs ``` This replaces the old `tox` based workflow with a new `just` based workflow. `tox` is no longer needed since `uv` manages all virtual environments. `just` is used instead, as a simple portable task runner.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## development #476 +/- ##
=============================================
+ Coverage 91.0% 91.5% +0.6%
=============================================
Files 25 25
Lines 7091 7091
=============================================
+ Hits 6450 6488 +38
+ Misses 641 603 -38 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Member
Author
|
This PR significantly changes the PyRTL developer workflow, but I think the advantages are worth it. Please let me know if you have questions or comments, otherwise I'll merge this in about a week. |
…nheritance_diagram`. Also: Add a `presubmit` target to the `justfile`, which just runs both `tests` and `docs`. Add some documentation on running the `presubmit` workflow before sending a pull request.
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
1 participant
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.
Migrating to
uvhas several advantages:The new workflow is significantly faster. On my computer:
uvmanages installation of the appropriate versions of Python and all pippackages, greatly simplifying the creation of PyRTL development
environments
This pins all developer tools to specific versions. Previously we only pinned
documentation tools. This avoids confusing situations where lint errors
suddenly appear just because a new version of
ruffwas released.To run all tests with the new workflow:
To build documentation with the new workflow:
This replaces the old
toxbased workflow with a newjustbased workflow.toxis no longer needed sinceuvmanages all virtual environments.justis used instead, as a simple portable task runner.