feat(docker-pass): update docs#25321
Conversation
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🔴 CRITICAL
All 5 files changed in this PR are in data/cli/secrets/, a data/*/*.yaml subdirectory that the project designates as auto-generated CLI reference data (produced from upstream). Manual edits to these files should be made upstream and vendored/generated into this repo — not authored here directly.
See inline comments for details.
| internal secrets used by other plugins, such as the 1Password service | ||
| account token). Always on; not configurable. | ||
|
|
||
| #### 1Password (configurable) |
There was a problem hiding this comment.
[HIGH] Manual edits to auto-generated CLI reference YAML in data/cli/secrets/ — should be rejected
This file lives in data/cli/secrets/, which matches the data/*/*.yaml pattern that the project designates as auto-generated CLI reference data produced from upstream. Changes to these files must be made in the upstream source repository and vendored/generated into this docs repo — not hand-authored here.
This diff adds 114 lines of 1Password integration documentation directly to docker_pass.yaml. Those changes belong upstream.
| @@ -0,0 +1,42 @@ | |||
| command: docker pass plugins 1password | |||
There was a problem hiding this comment.
[HIGH] New auto-generated YAML file authored manually in data/cli/secrets/
data/cli/secrets/docker_pass_plugins_1password.yaml is a new file hand-authored directly in the auto-generated subdirectory. Per project rules, all YAML files under data/*/*.yaml subdirectories are produced by upstream CLI tooling — this file should be generated from upstream, not created here.
| @@ -0,0 +1,15 @@ | |||
| command: docker pass plugins 1password purge | |||
There was a problem hiding this comment.
[HIGH] New auto-generated YAML file authored manually in data/cli/secrets/
data/cli/secrets/docker_pass_plugins_1password_purge.yaml is a new file hand-authored directly in the auto-generated subdirectory. Per project rules, all YAML files under data/*/*.yaml subdirectories are produced by upstream CLI tooling — this file should be generated from upstream, not created here.
| @@ -0,0 +1,17 @@ | |||
| command: docker pass plugins 1password setup | |||
There was a problem hiding this comment.
[HIGH] New auto-generated YAML file authored manually in data/cli/secrets/
data/cli/secrets/docker_pass_plugins_1password_setup.yaml is a new file hand-authored directly in the auto-generated subdirectory. Per project rules, all YAML files under data/*/*.yaml subdirectories are produced by upstream CLI tooling — this file should be generated from upstream, not created here.
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
The missing context is that the docs are auto generated but the PR is not. |
| internal secrets used by other plugins, such as the 1Password service | ||
| account token). Always on; not configurable. | ||
|
|
||
| #### 1Password (configurable) |
There was a problem hiding this comment.
[HIGH] Possible manual edits to auto-generated/vendored CLI reference YAML files
All five changed files are in data/cli/secrets/, which matches the data/*/*.yaml pattern for auto-generated CLI reference data that is vendored from upstream repos. Per project rules, these files must be updated by the upstream generator tool — not edited directly in the docs repo.
The PR description says "auto generated," which is encouraging, but the branch name feat/pass-v3 is a feature branch rather than a typical sync/generation branch. If this content was indeed produced by an upstream generator, please confirm that the generator was updated and these files were produced by re-running it. If the content was edited by hand, it will likely be overwritten on the next generation run.
|
|
||
| ##### CLI version | ||
|
|
||
| - **Plugin name:** `1password-cli` |
There was a problem hiding this comment.
[MEDIUM] Bold **Term:** description list format — prohibited by STYLE.md
The new content uses **Plugin name:**, **How it authenticates:**, **Setup:**, **Behavior:**, **Fatal errors:**, **Enable / disable:**, and **Teardown:** as bold labels in list items. STYLE.md explicitly flags the **Term:** Description pattern as marketing-style list formatting to avoid.
Bold should be reserved for UI elements only (buttons, menus, field labels).
Consider plain prose alternatives — for example, use a subheading or plain text with a colon:
- Plugin name: `1password-cli`
- Authentication: delegates to the `op` CLI.
Or restructure as a definition-style paragraph.
| `op`, sign in, accept the prompt) and re-enable the plugin with | ||
| `docker pass plugins enable 1password-cli`. | ||
| - **Enable / disable:** | ||
| ```sh |
There was a problem hiding this comment.
[MEDIUM] Code fence uses sh instead of required console language hint
Docker's style guide requires console (not sh) as the language hint for interactive shell commands shown to users. This applies to all three sh blocks added in docker_pass.yaml (lines 175, 188, and 192).
Change:
```sh
docker pass plugins enable 1password-cli
to:
```console
$ docker pass plugins enable 1password-cli
| examples: |- | ||
| Install the service account token and enable the plugin: | ||
|
|
||
| ```sh |
There was a problem hiding this comment.
[MEDIUM] Code fences use sh instead of required console language hint
Docker's style guide requires console (not sh) for interactive shell commands. Both code fences in the examples block use sh.
Change sh to console and prefix commands with $ :
```console
$ echo "$OP_SERVICE_ACCOUNT_TOKEN" | docker pass plugins 1password setup
3 participants
Description
Updated docker-pass docs (auto generated)
Related issues or tickets
Reviews