Repository navigation
docs(secrets): credential helper only supplies DOCKER_TOKEN - #4701
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The focused documentation changes match existing behavior, with no unresolved issues identified.
No open issues 🎉
What changed in this PR
This documentation-only update aligns the secrets guide with the credential helper’s existing behavior.
Changes:
- Clarifies that credential helpers supply only
DOCKER_TOKENand receive no appended arguments. - Corrects the 1Password helper example and scopes both comparison tables accordingly.
- Adds guidance for keeping
op://references separate from variables used by other tools.
| File | Description |
|---|---|
| docs/guides/secrets/index.md | Corrects credential helper documentation and adds 1Password reference guidance. |
Review effort: Balanced
The guide said the helper gets the variable name appended and serves any secret. CredentialHelperProvider only answers DOCKER_TOKEN and runs the command as configured. Fix the section, table rows and example. Spell out that op:// resolution is independent of the helper and applies to every variable, API keys included, and add a tip on keeping op:// references out of the shell so tools like Claude Code and Codex do not read them. Signed-off-by: Arnaud Héritier <aheritier@apache.org>
aheritier
force-pushed
the
docs/secrets-credential-helper
branch
from
October 22, 2026 11:47
d88ab93 to
cfbcd49
Compare
trungutt
approved these changes
Oct 22, 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
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
The secrets guide described
credential_helperas a general secret source that receives the variable name as its last argument. The code does neither:CredentialHelperProvider.Getreturns nothing for any name other thanDOCKER_TOKEN(pkg/environment/credential_helper.go).Following the old example (
op read op://Personal/docker-agent) to load provider API keys silently does nothing.Changes
DOCKER_TOKEN, point other secrets to the remaining sources, fix the example and the invocation description.op://resolution is independent of the helper and works for every variable, API keys included.op://references, since anophelper example reads as "this is how to load keys from 1Password".op://values out of the shell (Docker Agent env file ortoken_key), since tools such as Claude Code and Codex read the same variables and do not resolveop://.References
pkg/environment/credential_helper.gopkg/userconfig/userconfig.go(CredentialHelper)pkg/environment/default.goop readop readtoken_key