Skip to content

Commit 45f3e3a

Browse files
authored
Merge pull request #777 from docker/release-update-docs
ci(release): add update-docs job to vendor CLI docs in docker/docs
2 parents 4c223f4 + fcee347 commit 45f3e3a

File tree

1 file changed

+63
-2
lines changed

1 file changed

+63
-2
lines changed

.github/workflows/release.yml

Lines changed: 63 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ on:
4747
type: boolean
4848
default: false
4949
imagesOnly:
50-
description: "Only build and push Docker images (skip CLI releases, pinata bump, and CE packaging)"
50+
description: "Only build and push Docker images (skip CLI releases, pinata bump, docs update, and CE packaging)"
5151
required: false
5252
type: boolean
5353
default: false
@@ -516,6 +516,67 @@ jobs:
516516
517517
draft: true
518518

519+
# ---------------------------------------------------------------------------
520+
# Update CLI reference docs in docker/docs
521+
# ---------------------------------------------------------------------------
522+
update-docs:
523+
if: ${{ !inputs.imagesOnly }}
524+
needs: [prepare]
525+
runs-on: ubuntu-latest
526+
permissions:
527+
contents: read
528+
steps:
529+
- name: Checkout docs
530+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
531+
with:
532+
repository: docker/docs
533+
token: ${{ secrets.CLI_RELEASE_PAT }}
534+
fetch-depth: 0
535+
536+
- name: Set up Go
537+
uses: actions/setup-go@4b73464bb391d4059bd26b0524d20df3927bd417
538+
with:
539+
go-version: 1.25.8
540+
cache: true
541+
542+
- name: Vendor model-runner CLI docs
543+
env:
544+
RELEASE_TAG: ${{ needs.prepare.outputs.release_tag }}
545+
run: |
546+
VENDOR_MODULE=github.com/docker/model-runner@${RELEASE_TAG} make vendor
547+
548+
- name: Create pull request
549+
uses: peter-evans/create-pull-request@c0f553fe549906ede9cf27b5156039d195d2ece0
550+
with:
551+
token: ${{ secrets.DOCKER_DOCS }}
552+
base: main
553+
push-to-fork: ilopezluna/docs
554+
commit-message: |
555+
vendor: github.com/docker/model-runner ${{ needs.prepare.outputs.release_tag }}
556+
557+
See changes in https://github.com/docker/model-runner/compare/${{ needs.prepare.outputs.previous_tag }}...${{ needs.prepare.outputs.release_tag }}.
558+
branch: update-model-runner-${{ needs.prepare.outputs.release_tag }}
559+
title: "vendor: github.com/docker/model-runner ${{ needs.prepare.outputs.release_tag }}"
560+
body: |
561+
## Description
562+
563+
Update Model Runner CLI docs.
564+
See changes in https://github.com/docker/model-runner/compare/${{ needs.prepare.outputs.previous_tag }}...${{ needs.prepare.outputs.release_tag }}.
565+
566+
```
567+
VENDOR_MODULE=github.com/docker/model-runner@${{ needs.prepare.outputs.release_tag }} make vendor
568+
```
569+
570+
## Reviews
571+
572+
<!-- Notes for reviewers here -->
573+
<!-- List applicable reviews (optionally @tag reviewers) -->
574+
575+
- [ ] Technical review
576+
- [ ] Editorial review
577+
- [ ] Product review
578+
draft: true
579+
519580
# ---------------------------------------------------------------------------
520581
# Release CLI for Docker CE — build .deb/.rpm packages and deploy
521582
#
@@ -631,7 +692,7 @@ jobs:
631692
# Create GitHub Release with AI-generated release notes
632693
# ---------------------------------------------------------------------------
633694
github-release:
634-
needs: [prepare, release-notes, build, release-cli-desktop, bump-pinata, verify-docker-ce]
695+
needs: [prepare, release-notes, build, release-cli-desktop, bump-pinata, update-docs, verify-docker-ce]
635696
if: ${{ !cancelled() && !contains(needs.*.result, 'failure') }}
636697
runs-on: ubuntu-latest
637698
permissions:

0 commit comments

Comments
 (0)