Skip to content

docs: clarify credential helper release binary names - #478

Open
sean0407 wants to merge 1 commit into
docker:mainfrom
sean0407:codex/docker-credential-helpers-368-doc-binary-name
Open

sean0407 wants to merge 1 commit into
docker:mainfrom
sean0407:codex/docker-credential-helpers-368-doc-binary-name

Conversation

@sean0407

Copy link
Copy Markdown

Summary

Clarifies the executable name Docker expects for each credential helper and how to rename a versioned release asset. Fixes #368.

What I did: Updated the README installation instructions with the docker-credential-<credsStore suffix> naming rule and a pass example.

How I did it: Documented renaming a versioned/platform release asset before adding it to $PATH.

Description for the changelog: Clarify how to name downloaded credential helper binaries.

Evidence

  • Before: The README said to download the binary and put it in $PATH; the v0.9.10 Linux asset is named docker-credential-pass-v0.9.10.linux-amd64, while the README usage example resolves the helper as docker-credential-pass.
  • After: The installation section explains the required rename.
  • How to verify: Compare the release asset name with the helper name shown in the README installation and usage sections.
  • git diff --check passed.
  • Patch policy accepted one Markdown file, with no binary changes.

Merge Danger

Door: Two-way

Blast Radius: Documentation

Signed-off-by: Sean Li <22557931+sean0407@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Include in the installation guide about the expected naming of the binary

1 participant