Skip to content

feat(pass): documentation#511

Merged
joe0BAB merged 1 commit into
mainfrom
feat/docs
Apr 23, 2026
Merged

feat(pass): documentation#511
joe0BAB merged 1 commit into
mainfrom
feat/docs

Conversation

@joe0BAB

@joe0BAB joe0BAB commented Apr 23, 2026

Copy link
Copy Markdown
Collaborator

No description provided.

@joe0BAB joe0BAB marked this pull request as ready for review April 23, 2026 09:50

@docker-agent docker-agent Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assessment: 🟡 NEEDS ATTENTION

One documentation inaccuracy was confirmed in the changed code.

Comment thread plugins/pass/commands/get.go Outdated
Signed-off-by: Johannes Großmann <grossmann.johannes@t-online.de>
@joe0BAB

joe0BAB commented Apr 23, 2026

Copy link
Copy Markdown
Collaborator Author

/review

@docker-agent docker-agent Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assessment: 🟡 NEEDS ATTENTION

Comment thread plugins/pass/command.go
Use: "pass [OPTIONS]",
Use: "pass [OPTIONS]",
Short: "Manage your local OS keychain secrets.",
Long: `Docker Pass is an experimental utility for managing secrets in your

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[MEDIUM] Long descriptions are never rendered — {{.Long}} missing from helpTemplate

The Long descriptions added in this PR (for the root command and all four subcommands: get, set, list, rm) will never appear in CLI help output.

Root cause: The custom helpTemplate defined in command.go (set via cmd.SetHelpTemplate) does not include {{.Long}}. Cobra propagates the parent's help template to all child commands unless they override it, and none of the subcommands set their own template. As a result, running docker pass --help, docker pass get --help, etc. silently drops every Long description.

Impact: All the documentation effort in this PR is functionally dead code — users will never see those detailed descriptions through the CLI.

Fix: Either add {{if .Long}}{{.Long}}\n\n{{end}} to the helpTemplate in command.go, or remove the Long fields if only Short is needed and external doc generation is not planned.

@joe0BAB joe0BAB merged commit 624377a into main Apr 23, 2026
15 of 16 checks passed
@joe0BAB joe0BAB deleted the feat/docs branch April 23, 2026 11:05
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.

2 participants