-
Notifications
You must be signed in to change notification settings - Fork 22
docs: Add example authentication configurations #104
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
Merged
Merged
Conversation
This file contains hidden or 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
2070895 to
30370f5
Compare
19d45ad to
bb40c7a
Compare
heckj
reviewed
Apr 23, 2025
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.
great examples!!!
A few nits - basically introducing each list of instructions under the headers, and one minor rewrite to tighten and make the call to action more explicit
Sources/swift-container-plugin/Documentation.docc/authentication.md
Outdated
Show resolved
Hide resolved
…on.md Co-authored-by: Joseph Heck <[email protected]>
…on.md Co-authored-by: Joseph Heck <[email protected]>
…on.md Co-authored-by: Joseph Heck <[email protected]>
…on.md Co-authored-by: Joseph Heck <[email protected]>
heckj
approved these changes
Apr 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
Motivation
Public container registries often have more complex authentication schemes than privately-hosted registries. For instance, they might use authentication tokens instead of passwords, or authentication might be a separate service from the registry. Users will benefit from being able to refer to examples which show suitable
.netrcentries, with information about how to generate tokens and avoid common problems.Modifications
Add example configurations for a number of popular container registries.
Result
New users can refer to concrete examples of
.netrcstanzas for popular container registries, along with outline instructions explaining how to generate the necessary authentication tokens.Test Plan
Manually tested the instructions.
Automated tests continue to pass, no new documentation warnings.