-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Add warning about ~/.netrc for Poetry credential configuration
#10630
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideDocuments a known issue where a ~/.netrc file can override Poetry’s configured HTTP basic auth credentials and adds a prominent warning to the repositories configuration docs to help users debug authorization failures. Flow diagram for debugging Poetry authorization failures due to .netrcflowchart TD
A[Configure http-basic credentials with poetry config] --> B[Run poetry install or update]
B --> C{Authorization succeeds?}
C -->|Yes| D[Continue normal workflow]
C -->|No| E[Check for presence of ~/.netrc]
E --> F{Does ~/.netrc exist?}
F -->|No| G[Investigate other causes of auth failure]
F -->|Yes| H[Inspect ~/.netrc for entries related to the repository host]
H --> I{Conflicting credentials found?}
I -->|No| G
I -->|Yes| J[Modify or remove conflicting ~/.netrc entries]
J --> K[Retry poetry command]
K --> C
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey there - I've reviewed your changes - here's some feedback:
- The warning text and dragon emoji are quite informal compared to the rest of the docs; consider rephrasing to a neutral, descriptive style that matches the existing documentation tone.
- It might help users if the warning briefly explains how
~/.netrcconflicts with Poetry authentication (e.g., precedence/override behavior) rather than just saying it is “known to conflict.” - Clarify whether the
~/.netrcinteraction applies to all repository types and authentication methods described on this page, or only certain configurations, so users know when this warning is relevant.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The warning text and dragon emoji are quite informal compared to the rest of the docs; consider rephrasing to a neutral, descriptive style that matches the existing documentation tone.
- It might help users if the warning briefly explains *how* `~/.netrc` conflicts with Poetry authentication (e.g., precedence/override behavior) rather than just saying it is “known to conflict.”
- Clarify whether the `~/.netrc` interaction applies to all repository types and authentication methods described on this page, or only certain configurations, so users know when this warning is relevant.
## Individual Comments
### Comment 1
<location> `docs/repositories.md:44-47` </location>
<code_context>
```
+{{% warning %}}
+🐉 HERE LIE DRAGONS 🐉
+If you have completed configuring credentials and are receiving authorization failures, check for the presence of `~/.netrc` which has been known to conflict with poetry's configured authentication.
+{{% /warning %}}
</code_context>
<issue_to_address>
**nitpick (typo):** Consider adding a comma before "which" and capitalizing "Poetry" for consistency.
For example: `...check for the presence of `~/.netrc`, which has been known to conflict with Poetry's configured authentication.`
```suggestion
{{% warning %}}
🐉 HERE LIE DRAGONS 🐉
If you have completed configuring credentials and are receiving authorization failures, check for the presence of `~/.netrc`, which has been known to conflict with Poetry's configured authentication.
{{% /warning %}}
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
Ain't no clanker making docs suggestions to me! (Written by Claude 🤖) — proof. |
ajchili
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am the someone. While we did not immediately reference docs, having this be explicitly called out will help others.
Added warning about potential authorization issues with Poetry and .netrc file.
tbh, good suggestion sourcery-ai. Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
|
Deploy preview for website ready! ✅ Preview Built with commit 53ce62f. |
{{% warning %}} should be sufficient.
~/.netrc for Poetry credential configuration
|
lol @nickhudkins i just spent a day fighting this issue |
|
HOLD THE HECK ON RIGHT NOW MISTER HUGANIR! How have you been?! Let's move this to a social networking platform, like phones or something. If I recall properly, we were nearly number neighbors, |
Added warning about potential authorization issues with Poetry and .netrc file.
I didn't even have this issue, but I sat next to someone who did, for many hours, and it was painful to say the least. Finding that there is an outstanding issue with people suggesting a change to the documentation but then not proposing that change, I figured I'd go ahead and.... do the thing.
Pull Request Check List
Doesn't resolve but until it is, may as well let folks know:
#8443
Summary by Sourcery
Documentation: