docs(pip-compile): Add note re proper usage of index-url #29421
Merged
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
rarkins
previously approved these changes
Jun 4, 2024
rarkins
changed the title
Renovate doesn't parse the `--index-url` option from the lockfiles, it just runs pip-compile and pip-compile finds its own `--index-url` (from the `.in` files instead.) This change adds a note to the docs to draw attention to that
auto-merge was automatically disabled
June 4, 2024 20:22
Head branch was pushed to by a user without write access
craigds
force-pushed
the
pip-compile-index-url-note
branch
from
4a889b1
to
041f8f3
Compare
rarkins
approved these changes
Jun 5, 2024
|
🎉 This PR is included in version 37.391.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Changes
Renovate doesn't parse the
--index-urloption from the lockfiles, it just runs pip-compile and pip-compile finds its own--index-url(from the.infiles instead.)The docs actually already do state which file the
--index-urlshould go in, but since some of the other config comes from the lockfile, I didn't expect to have to add the index URL in the.infile and so I glossed over that.This PR draws attention to that detail so other people won't gloss over it :)
Context
borne from my confusion here.
Documentation (please check one with an [x])
How I've tested my work (please select one)
I have verified these changes via: