ci: Add automated CLI documentation sync workflow #23867
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
vvoland
force-pushed
the
bot-update-cli-docs
branch
from
9d2c000 to
5ef3605
Compare
.github/workflows/sync-cli-docs.yml
Outdated
| name: Run sync script | ||
| id: sync | ||
| run: | | ||
| if ./hack/sync-cli-docs.sh cli-source origin/master; then |
There was a problem hiding this comment.
We do not vendor the CLI docs from master - we vendor a tag or release branch (there might be exceptions to this rule but in general). Maybe we could leverage the docker_ce_version config, and use the release branch?
There was a problem hiding this comment.
Ah, yes, I was wondering that as well; we should probably pick the version we vendor (which should be a tagged version)?
There was a problem hiding this comment.
Changed to pick the one from hugo.yaml
There was a problem hiding this comment.
As a follow-up, we should look at having a Dockerfile target that we can build from; that way we don't have to clone the git repository, but instead can just do something like;
docker build --target=yamldocs --output=./<destination> https://github.com/docker/cli#<git ref>
vvoland
force-pushed
the
bot-update-cli-docs
branch
5 times, most recently
from
4a2dcf3 to
bc3d914
Compare
vvoland
force-pushed
the
bot-update-cli-docs
branch
6 times, most recently
from
1db1bda to
53548f1
Compare
|
The latest release needs to include docker/cli#6716 |
vvoland
force-pushed
the
bot-update-cli-docs
branch
from
53548f1 to
1f51e28
Compare
| # TODO(vvoland): Remove this after 29.2.0 is released | ||
| VERSION=60f06cb2df3df36ddfb531c1dae8c6fa96e5f9e7 |
There was a problem hiding this comment.
Gonna remove this after docker/cli#6716 is included in the latest version
vvoland
force-pushed
the
bot-update-cli-docs
branch
from
1f51e28 to
6ad9f95
Compare
vvoland
force-pushed
the
bot-update-cli-docs
branch
4 times, most recently
from
e902fc6 to
2fe3c49
Compare
vvoland
force-pushed
the
bot-update-cli-docs
branch
from
2fe3c49 to
1e643d9
Compare
This adds a GitHub Actions workflow and supporting script to automatically sync CLI documentation from the docker/cli repository on a daily schedule. Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
vvoland
force-pushed
the
bot-update-cli-docs
branch
from
1e643d9 to
c365245
Compare
|
Should be good now! |
| run: | | ||
| git push -u origin "${{ steps.create-branch.outputs.branch_name }}" | ||
| gh pr create \ |
There was a problem hiding this comment.
Curious; where does it create the branch? Is that in a separate repository or directly here in the upstream?
There was a problem hiding this comment.
Directly in the upstream:
docs/.github/workflows/sync-cli-docs.yml
Line 55 in c365245
Not ideal but... works
There was a problem hiding this comment.
And this repo already uses dependabot so 😅
3 participants
This adds a GitHub Actions workflow and supporting script to automatically sync CLI documentation from the docker/cli repository on a daily schedule.
Description
Related issues or tickets
Reviews