Skip to content

Commit 7f37cdc

Browse files
committed
📝 docs: Update TestPyPI installation instructions
Improve uv pip install command for TestPyPI with detailed explanation of index strategy and extra index URL usage. Clarify the rationale behind using unsafe-best-match strategy for package installation.
1 parent 27b90a4 commit 7f37cdc

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

‎docs/releasing.md‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,15 @@ uv venv test-pypi-env
122122
source test-pypi-env/bin/activate
123123

124124
# Install from TestPyPI
125-
# Note: --extra-index-url allows installing dependencies from main PyPI
126-
uv pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ phabfive
125+
# --index-strategy unsafe-best-match: Required because uv's default security
126+
# prevents mixing package versions from different indexes. Since you control
127+
# both TestPyPI and PyPI for phabfive, this is safe and necessary.
128+
# --extra-index-url: Allows dependencies (like mkdocs) to be installed from PyPI
129+
uv pip install \
130+
--index-url https://test.pypi.org/simple/ \
131+
--extra-index-url https://pypi.org/simple/ \
132+
--index-strategy unsafe-best-match \
133+
phabfive
127134

128135
# Verify it works
129136
phabfive --help

0 commit comments

Comments
 (0)