docs: update CI examples to use uv and tox-uv #2213
Merged
Conversation
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR modernizes the CI examples in the documentation by replacing the traditional pip install tox approach with uv and tox-uv tooling. This aligns the documentation with the latest machine and Kubernetes Charmcraft profiles that expect these tools to be used.
Key changes:
- Updates Python setup action from v5 to v6
- Introduces
astral-sh/setup-uvaction for uv installation - Replaces pip-based tox installation with
uv tool install tox --with tox-uv
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/howto/write-and-structure-charm-code.md | Updates three CI workflow examples (lint, unit tests, integration tests) to use uv and tox-uv |
| docs/explanation/testing.md | Updates unit test CI example to use uv and tox-uv, adds missing Python setup step |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
dwilding
commented
Dec 3, 2025
dimaqq
approved these changes
Dec 3, 2025
james-garner-canonical
approved these changes
Dec 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This PR updates how tox is installed in the GitHub CI examples in our docs. The latest machine and Kubernetes Charmcraft profiles expect uv, tox, and tox-uv, so I figure it's good for our docs to show that too.
Unlike in our own CI, I've not pinned the uv action to a specific commit. Should we mention something about this in the docs?