docs(OBS-1658): split git config example per auth mode#336
Merged
leoparente merged 2 commits intodevelopfrom Apr 24, 2026
Merged
docs(OBS-1658): split git config example per auth mode#336leoparente merged 2 commits intodevelopfrom
leoparente merged 2 commits intodevelopfrom
Conversation
Replace the single kitchen-sink git config example (which mixed
`auth: basic` with `private_key` fields and a misleading
`${PASSWORD|TOKEN}` placeholder) with three focused snippets: public
repo, basic auth, and SSH auth.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
leoparente
requested review from
MicahParks,
grant-nbl,
jajeffries,
manrodrigues,
marc-barry,
mfiedorowicz and
paulstuart
as code owners
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
mfiedorowicz
approved these changes
Apr 24, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
docs/configs/git.mdwith three focused snippets: public repo, basic auth, and SSH auth.password: ${PASSWORD|TOKEN}placeholder and theprivate_keyline that appeared alongsideauth: basic.known_hostssetup.Closes OBS-1658. The ticket's original premise (that
auth: basicis unsupported) is incorrect —agent/configmgr/git.gohandles it — but the combined example was genuinely confusing, which is what this change fixes.Test plan
docs/configs/git.mdand confirm the three snippets display correctly#ssh-authenticationresolves🤖 Generated with Claude Code