docs(secrets): add repo setup step to docker pass install#25569
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🔴 CRITICAL
2 high-severity issues found in this PR.
| On Docker Desktop, Secrets Engine and `docker pass` are integrated by default. | ||
| For Docker CE, install the packages separately; this requires Docker Engine | ||
| (`dockerd`) 29.2.0 or later. | ||
| For Docker CE, install the packages separately from Docker's official |
There was a problem hiding this comment.
[HIGH] Manually editing a vendored/generated YAML file — critical auto-reject violation
data/cli/secrets/docker_pass.yaml lives under the data/cli/ subdirectory. Per this project's conventions, files in data/*/*.yaml subdirectories are auto-generated/vendored from upstream CLI repositories and must not be manually edited here.
This change needs to be made upstream in the repository that generates this file (the Docker CLI secrets engine repo), and then synced into this docs repo via the normal automation. Editing it directly here will be overwritten the next time the sync runs, and it bypasses the upstream review process.
| convenience script: | ||
| ```shell | ||
| curl -fsSL https://get.docker.com | sh -s -- --setup-repo |
There was a problem hiding this comment.
[HIGH] Potentially invalid --setup-repo flag in the get.docker.com convenience script
The added command:
curl -fsSL https://get.docker.com | sh -s -- --setup-repoThe --setup-repo flag is not a widely documented option for the get.docker.com convenience script. The standard documented usage is curl -fsSL https://get.docker.com | sh (which installs Docker Engine). If --setup-repo is unrecognised by the script, it will either error out or silently do nothing — leaving the user without the Docker repository configured, which is the entire purpose of this step.
Please verify that --setup-repo is a valid, supported flag in the current version of the script at https://get.docker.com before shipping this command to users.
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🔴 CRITICAL
This PR manually edits a generated/vendored CLI reference YAML file. Changes to files under data/*/*.yaml subdirectories are auto-generated from upstream sources and should not be edited directly in this repo.
| On Docker Desktop, Secrets Engine and `docker pass` are integrated by default. | ||
| For Docker CE, install the packages separately; this requires Docker Engine | ||
| (`dockerd`) 29.2.0 or later. | ||
| For Docker CE, install the packages separately from Docker's official |
There was a problem hiding this comment.
[HIGH] Manual edit to a generated/vendored CLI reference YAML file
data/cli/secrets/docker_pass.yaml lives under data/cli/**/*.yaml — a subdirectory of data/ whose YAML files are generated from upstream sources and should not be manually edited. The PR description itself says "Updated auto generated docker pass docs", confirming the file is auto-generated.
Manual edits to generated files are overwritten the next time the upstream sync runs, causing this change to silently disappear. The correct fix is to make the change upstream (in the source repo that generates this YAML) and let the sync propagate it to this repo.
3 participants
Description
Updated auto generated docker pass docs.
Related issues or tickets
Reviews