Skip to content

ci: add docs-release-* tag workflow to publish docs at release #3969

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
ericallam merged 2 commits into from
Jun 16, 2026
+36 −0
Merged

ci: add docs-release-* tag workflow to publish docs at release #3969

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e3cad1
ci: add docs-release-* tag workflow to publish docs at release
ericallam Jun 16, 2026
afee198
ci: drop npm cache from the docs publish workflow
ericallam Jun 16, 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
36 changes: 36 additions & 0 deletions .github/workflows/publish-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: 📚 Publish docs

on:
push:
tags:
- "docs-release-*"

# Only needs to move the docs-live ref; Mintlify's GitHub app deploys from it.
permissions:
contents: write

concurrency:
group: publish-docs
cancel-in-progress: false

jobs:
publish:
runs-on: ubuntu-latest
steps:
- name: 📥 Checkout tagged commit
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false

- name: 🔗 Check for broken links
working-directory: ./docs
run: npx mintlify@4.0.393 broken-links

- name: 🚀 Fast-forward docs-live to the tagged commit
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
gh api -X PATCH \
"repos/${{ github.repository }}/git/refs/heads/docs-live" \
-f sha="${{ github.sha }}" \
-F force=false