Skip to content

Update docs publication workflow for releases #33

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
thompsonmj merged 1 commit into from
Mar 31, 2026
Merged

Update docs publication workflow for releases #33

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
13 changes: 7 additions & 6 deletions .github/workflows/deploy-docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@ name: Build & Deploy MkDocs (gh-pages with PR previews)

on:
workflow_dispatch:
release:
types: [published]
pull_request:
branches: [ main ]
types: [opened, synchronize, reopened, closed]
push:
branches: [ main ]

permissions:
contents: write
pages: write

jobs:
build:
# Run for push, workflow dispatch, PRs from SAME repo that are not closed
# Run for release, workflow dispatch for manual validation (build only), PRs from SAME repo that are not closed
if: |
github.event_name == 'push' ||
github.event_name == 'release' ||
github.event_name == 'workflow_dispatch' ||
(github.event_name == 'pull_request' &&
github.event.pull_request.head.repo.fork == false &&
Expand All @@ -29,6 +29,7 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
ref: ${{ github.event_name == 'release' && github.event.release.tag_name || github.ref }}
- uses: actions/setup-python@v5
with:
python-version: "3.11"
Expand All @@ -46,9 +47,9 @@ jobs:

deploy:
needs: build
# Deploy on push to main (root) or PRs from SAME repo (not closed) -> pr-<N>/
# Deploy on release or PRs from SAME repo (not closed) -> pr-<N>/
if: |
github.event_name == 'push' ||
github.event_name == 'release' ||
(github.event_name == 'pull_request' &&
github.event.pull_request.head.repo.fork == false &&
github.event.action != 'closed')
Expand Down
Loading