Publish: Support --index <name> #9694
Merged
+300
−30
Conversation
This file contains 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
When publishing, we currently ask the user to set `--publish-url` to the upload URl and `--check-url` to the simple index URL, or the equivalent configuration keys. But that's redundant with the `[[tool.uv.index]]` declaration. Instead, we extend `[[tool.uv.index]]` with a `publish-url` entry and allow passing `uv publish --index <name>`. `uv publish --index <name>` requires the `pyproject.toml` to be present when publishing, unlike using `--publish-url ... --check-url ...` which can be used e.g. in CI without a checkout step. `--index` also always uses the check URL feature to aid upload consistency. The documentation tries to explain both approaches together, which overlap for the check URL feature. Fixes #8864
konstin
added
the
enhancement
konstin
had a problem deploying
to
uv-test-publish
GitHub Actions
Error
konstin
temporarily deployed
to
uv-test-publish
GitHub Actions
Inactive
zanieb
reviewed
Dec 10, 2024
zanieb
reviewed
Dec 10, 2024
Co-authored-by: Zanie Blue <[email protected]>
Co-authored-by: Zanie Blue <[email protected]>
konstin
temporarily deployed
to
uv-test-publish
GitHub Actions
Inactive
charliermarsh
approved these changes
Dec 10, 2024
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.
When publishing, we currently ask the user to set
--publish-urlto the upload URL and--check-urlto the simple index URL, or the equivalent configuration keys. But that's redundant with the[[tool.uv.index]]declaration. Instead, we extend[[tool.uv.index]]with apublish-urlentry and allow passinguv publish --index <name>.uv publish --index <name>requires thepyproject.tomlto be present when publishing, unlike using--publish-url ... --check-url ...which can be used e.g. in CI without a checkout step.--indexalso always uses the check URL feature to aid upload consistency.The documentation tries to explain both approaches together, which overlap for the check URL feature.
Fixes #8864