Credentials best practice
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 73
- Forks
- 351
- Avg merge
- 5h 21m
- Merged PRs (30d)
- 9
Description
https://github.com/sbt/website/blame/master/src/reference/02-DetailTopics/03-Dependency-Management/05-Publishing.md#L72 states that ~/.ivy2/.credentials is the preferred way to specify credentials. I disagree, at least as long as it doesn't clarify how to specify different credentials for multiple hosts.
IMHO the recommendation should be to put credentials in ~/.sbt/0.13/per-user-per-organization-credentials.sbt files like so:
credentials += Credentials("My realm", "some.host", "user", "password")
The recommendation to put credential settings (e.g. credentials += Credentials(Path.userHome / ".ivy2" / ".credentials")) into projects should also be discouraged. The reason being different projects being published to different artifact repositories an the Ivy credentials file being not flexible enough.
Does it make sense or am I missing something?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open src/reference/02-DetailTopics/03-Dependency-Management/05-Publishing.md around line 72 and review the current credentials recommendation. Compare the documented ~/.ivy2/.credentials approach with the proposed per-user-per-organization-credentials.sbt example and its multi-host use case. Done means the publishing documentation clearly explains the preferred credential setup and the limitations of project-level settings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100