Skip to content

ci: overlay docs from base_branch onto trunk for release #1901

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

Open
Jeadie wants to merge 5 commits into
base: trunk
Choose a base branch
from
Open

ci: overlay docs from base_branch onto trunk for release #1901

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
316a24e
ci: add base_branch input to create-release workflow
Jeadie Jul 8, 2026
fd54e1e
ci: overlay docs from base_branch onto trunk for release
Jeadie Jul 8, 2026
9bd9657
ci: force-push release branch to allow re-runs
Jeadie Jul 8, 2026
fe22200
ci: use run_id in release branch name to avoid conflicts
Jeadie Jul 8, 2026
d201405
ci: restore website/docs to trunk before committing versioned snapshot
Jeadie Jul 8, 2026
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
19 changes: 15 additions & 4 deletions .github/workflows/create_release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,14 @@ on:
workflow_dispatch:
inputs:
version:
description: "Version number (e.g. 2.0)"
description: "Version number (e.g. 2.0). Becomes `website/versioned_docs/version-{version_number}.x`."
required: true
type: string
base_branch:
description: "Git branch to copy from as the versioned docs."
required: false
default: "trunk"
type: string

permissions:
contents: write
Expand All @@ -21,27 +26,33 @@ jobs:
with:
ref: trunk

- name: Overlay docs from base branch
run: |
git fetch origin ${{ inputs.base_branch }}
git checkout FETCH_HEAD -- website/docs

- name: Create release branch and run release script
working-directory: website
run: |
git checkout -b "release/docs-v${{ inputs.version }}"
git checkout -b "release/docs-v${{ inputs.version }}-${{ github.run_id }}"
./create-release.sh "${{ inputs.version }}"

- name: Commit and push
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git checkout trunk -- website/docs
git add -A
git commit -m "Add versioned docs for v${{ inputs.version }}"
git push origin "release/docs-v${{ inputs.version }}"
git push origin "release/docs-v${{ inputs.version }}-${{ github.run_id }}"

- name: Create Pull Request
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
gh pr create \
--base trunk \
--head "release/docs-v${{ inputs.version }}" \
--head "release/docs-v${{ inputs.version }}-${{ github.run_id }}" \
--title "Add versioned docs for v${{ inputs.version }}" \
--body "Creates versioned documentation snapshot for v${{ inputs.version }}." \
--label "area/docs"
Loading