← Back to issue list

Improve uv plugin doc

View original Github issue

Metadata

Project
craft-parts
Number
#1101
Type
pull request
State
merged
Author
astrojuanlu
Labels
—
Created
Updated
Closed

Current evaluation

Merged in #1101 as c33fecc7, expanding uv installation docs, documenting setuptools for Sphinx builds, and adding a changelog entry.

Resolution: closed resolved

Reason: PR #1101 was approved and merged as commit c33fecc7. It improved the uv plugin documentation and docs-build dependency configuration.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you added an entry to the changelog (`docs/reference/changelog.rst`)? ----- I see that the uv plugin was partly inspired by the Go plugin (looking at the first few commits of #930) so I went ahead and expanded the explanation on how to actually get `uv` installed. I've seen some people define a custom `uv-deps` (like https://github.com/nsg/immich-distribution/blob/75d8511d2ca62b11ba25e66a37869eb06ff767e3/snap/snapcraft.yaml#L301-L310 or @lengau 's own https://github.com/lengau/astral-ty/blob/20a4f83c6fa369a189cdfe15e92f460b7c08f560/snap/snapcraft.yaml#L25-L34 ) but I guess `snap install astral-uv` is just easier? A couple more things: - `uv run --extra dev --extra apt-noble --extra docs sphinx-build ...` initially didn't work because of a missing `setuptools` dependency, so I added it. - Since the checklist asks for a changelog entry I added it, but looking at the history of the file it was not immediately clear to me how you folks handle unreleased entries and there's no `CONTRIBUTING.md` either so I did my best, but let me know if you prefer another approach.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged in #1101 as c33fecc7, expanding uv installation docs, documenting setuptools for Sphinx builds, and adding a changelog entry.
stealth/space-bunny-alpha — closed resolved Merged as c33fecc7: expanded astral-uv installation docs, documented setuptools for Sphinx builds, and added a changelog entry.
stealth/space-bunny-alpha — closed resolved Merged as c33fecc7: expanded astral-uv installation docs, documented setuptools for Sphinx builds, and added a changelog entry.
stealth/space-bunny-alpha — closed resolved Merged as c33fecc7 (#1101), improving uv installation and dependency documentation, adding setuptools, and recording the change in the changelog.
qwen/qwen3.6-35b-a3b — — Merged documentation updates for the uv plugin, expanding installation instructions, adding a setuptools dependency, and including a changelog entry. A CLA check failure was identified and resolved via a separate CI workflow update.
qwen3.6-35b-a3b-mtp-q6 — — Merged. Updated uv plugin documentation with clearer installation steps and added a missing setuptools dependency. Included a changelog entry. The initial CLA check failure was resolved after a separate workflow update PR merged.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/craft-parts#1115 (confidence 98%)

    Merged as 8d0c1253 to replace the legacy CLA checker workflow; this addressed the CI failure discussed on #1101.

Related issues

Issue Project State Summary Similarity
#2413 docs: clarify how to use the uv plugin charmcraft merged Merged PR #2413 as commit 2154ccbd, fixing #2238: uv examples now install astral-uv, while migration docs clarify runtime dependencies and uv.lock.
71%