docker / docker/docker-credential-helpers

Document output format of credential helpers

Open
#131 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
1.3k
Forks
195
Avg merge
1d 20h
Merged PRs (30d)
5

Description

The development section of the readme (https://github.com/docker/docker-credential-helpers/#development) specifies the input to credential helpers, but does not specify how the helpers should output the result.

Specifically:

  • Does get return the payload as provided to store?
  • What does list output?

I tried returning the payload in get and was not successful in making my helper work with docker.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the development section of the README and investigate the credential helper protocol around the get, store, and list operations. Document the expected output for get and list, including how stored payloads are represented, so a helper author can implement and verify those operations.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, go
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.