-
-
Notifications
You must be signed in to change notification settings - Fork 308
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
fix: enhance existing authentication docs #1780
base: master
Are you sure you want to change the base?
Conversation
|
||
1. The `--user` / `-u` cli option. | ||
1. a username (e.g. `__token__` for PyPI) |
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.
1. a username (e.g. `__token__` for PyPI) | |
1. a username (e.g. `__token__` for PyPI to select two-factor authentication aka. 2FA) |
|
||
1. The `--user` / `-u` cli option. | ||
1. a username (e.g. `__token__` for PyPI) | ||
2. a token value or other form of trusted authentication from the index (PyPI) |
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.
2. a token value or other form of trusted authentication from the index (PyPI) | |
2. a password, token value or other form of trusted authentication for the package index |
@@ -2,17 +2,32 @@ | |||
|
|||
---- | |||
|
|||
The username is derived from the following sources, in order of precedence: | |||
To publish to an index such as PyPI or TestPyPI you need two things: |
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.
To publish to an index such as PyPI or TestPyPI you need two things: | |
To publish to a package index such as PyPI or TestPyPI you need two things: |
Hi @lwasser , I just posted a couple of comments in the hope of making the help more explicit and easier to understand. Feel free to approve these changes or not :) |
@@ -62,6 +62,7 @@ dependencies = [ | |||
"pymdown-extensions~=10.8.1", | |||
# Necessary for syntax highlighting in code blocks | |||
"pygments~=2.18.0", | |||
"griffe<1.0", |
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.
(how) is this related to the proposed prose changes?
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 @funkyfuture i mentioned this to @ofek right now the docs won't build without this change in the hatch doc environment. I read it's a known issue. I think ofek wants to make the change separately / rebuild the environment. But if anyone wants to pull this down and build they will have issues without this change (or atleast that is what i discovered).
closes #821
This is a small update to the authentication page. it adds
✅ subheadings for easier skimming
✅ a breakout on 2FA as requested in #821
✅ a bit of clarification throughout.
I have two significant questions.
IN other words, if i just enter credentials manually using -u and-auth will hatch still try to override with the .pypirc file if it finds it? i'm now convinced that order is actually correct but i also haven't dug into the code yet.