Skip to content

ci: fix documentation release #25

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
danfimov merged 4 commits into from
Oct 26, 2025
Merged

ci: fix documentation release #25

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
52d5d76
ci: fix documentation release
danfimov Oct 26, 2025
84ce91a
ci: persist credentials to run deploy
danfimov Oct 26, 2025
e7d1620
ci: delete workflow_dispatch section
danfimov Oct 26, 2025
e91beb2
ci: final version of docs release pipeline
danfimov Oct 26, 2025
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
27 changes: 6 additions & 21 deletions .github/workflows/release_docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
name: Release docs
on:
workflow_dispatch:
inputs:
pr:
description: Pull request number to release docs for
required: true
type: string

pull_request:
types: [closed]
branches: [ main ]
Expand All @@ -19,19 +12,9 @@ jobs:
if: ${{ github.event_name == 'workflow_dispatch' || (github.event_name == 'pull_request' && github.event.pull_request.merged == true) }}
runs-on: ubuntu-latest
steps:
- name: Checkout merge commit (auto on merge to main)
if: ${{ github.event_name == 'pull_request' }}
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
ref: ${{ github.event.pull_request.merge_commit_sha }}
persist-credentials: false

- name: Checkout PR merge ref (manual on PR)
if: ${{ github.event_name == 'workflow_dispatch' }}
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
ref: refs/pull/${{ inputs.pr }}/merge
persist-credentials: false
persist-credentials: true

- name: Configure Git Credentials
run: |
Expand All @@ -43,5 +26,7 @@ jobs:
enable-cache: true
python-version: "3.12"
version: "latest"
- run: uv sync --only-dev
- run: uv run mkdocs gh-deploy --force
- name: Install Dependencies
run: uv sync --only-group docs
- name: Deploy Docs
run: uv run mkdocs gh-deploy --force