Skip to content

Re-write cli doc update workflow #245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fibonacci1729 merged 1 commit into from
Oct 27, 2026
Merged

Re-write cli doc update workflow #245

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 29 additions & 20 deletions .github/workflows/update-cli-reference.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,14 @@ name: Update CLI reference

on:
workflow_dispatch:
# repository_dispatch:
# types:
# - spin-release
inputs:
version:
description: "Spin version to generate the reference for (e.g. v4.1.0)"
required: false
default: latest
repository_dispatch:
types:
- spin-release

jobs:
create-pr:
Expand All @@ -16,22 +21,26 @@ jobs:
- name: Download Spin
uses: fermyon/actions/spin/setup@v1
with:
version: canary # for testing
version: ${{ github.event.client_payload.version || inputs.version || 'latest' }}
github_token: ${{ secrets.GITHUB_TOKEN }}

- name: Create CLI reference front matter
- name: Generate reference doc
id: generate
run: |
cat >./content/v3/cli-reference.md << EOF
title = "Command Line Reference"
template = "main"
date = "2025-01-01T00:00:01Z"
[extra]
url = "https://github.com/spinframework/spin-docs/blob/main/content/v3/cli-reference.md"
SPIN_VERSION=$(spin --version | awk '{print $2}')
MAJOR=${SPIN_VERSION%%.*}
DOC="content/v${MAJOR}/cli-reference.md"
if [ ! -f "$DOC" ]; then
echo "::error::$DOC does not exist - fork the docs for Spin v${MAJOR} before regenerating the CLI reference"
exit 1
fi

---
EOF
# Truncate the doc at the '---'
sed -i '/^---$/q' "$DOC"

- name: Generate reference doc
run: spin maintenance generate-reference >>./content/v3/cli-reference.md
spin maintenance generate-reference >> "$DOC"
echo "spin-version=$SPIN_VERSION" >> "$GITHUB_OUTPUT"
echo "major=$MAJOR" >> "$GITHUB_OUTPUT"

- name: Import GPG key
uses: crazy-max/ghaction-import-gpg@v7
Expand All @@ -44,13 +53,13 @@ jobs:
- name: Create pull request
uses: peter-evans/create-pull-request@v8
with:
commit-message: "Update Spin CLI reference to latest"
title: "Update Spin CLI reference to latest"
body: "Update Spin CLI reference to latest"
branch: bump-spin-cli-reference
commit-message: "Update CLI reference for Spin ${{ steps.generate.outputs.spin-version }}"
title: "Update CLI reference for Spin ${{ steps.generate.outputs.spin-version }}"
body: "Update the Spin CLI reference to match Spin ${{ steps.generate.outputs.spin-version }}."
branch: bump-spin-cli-reference-v${{ steps.generate.outputs.major }}
base: main
delete-branch: true
committer: spinframeworkbot <202838904+spinframeworkbot@users.noreply.github.com>
author: spinframeworkbot <202838904+spinframeworkbot@users.noreply.github.com>
signoff: true
token: ${{ secrets.PAT }}
token: ${{ secrets.PAT }}
Loading