Skip to content

Commit c3a9899

Browse files
authored
chore: make sure that release documentation is using the new version (#60)
* Update docs.yaml * Update release.yaml * Update docs.yaml * Update release.yaml * Update qualify.yaml
1 parent 3e8d4d2 commit c3a9899

3 files changed

Lines changed: 10 additions & 1 deletion

File tree

.github/workflows/docs.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ on:
1919
Set the alias as the default version
2020
type: boolean
2121
default: true
22+
ref:
23+
description: >-
24+
The ref to checkout and use to create docs
25+
type: string
26+
default: ""
2227
push:
2328
description: >-
2429
Push the documentation to the remote branch
@@ -36,6 +41,7 @@ jobs:
3641
- uses: actions/checkout@v4
3742
with:
3843
fetch-depth: 0 # Required to push to the documentation branch
44+
ref: ${{ inputs.ref }}
3945

4046
- name: Install the latest version of uv
4147
uses: astral-sh/setup-uv@v5

.github/workflows/qualify.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ permissions:
2020

2121
jobs:
2222
docs:
23-
if: github.event.pull_request.draft == false
23+
if: contains(github.event.pull_request.labels.*.name, 'documentation')
2424
name: Test deploy documentation
2525
uses: ./.github/workflows/docs.yaml
2626
concurrency:

.github/workflows/release.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ jobs:
1313
delete-test-document:
1414
name: Delete test documentation
1515
runs-on: ubuntu-latest
16+
if: contains( github.event.pull_request.labels.*.name, 'documentation')
1617
concurrency:
1718
group: gh-pages
1819
cancel-in-progress: false
@@ -128,10 +129,12 @@ jobs:
128129
mkdocs:
129130
name: Deploy documentation
130131
needs: [publish, delete-test-document]
132+
if: ${{ always() && !failure() && !cancelled() }}
131133
uses: ./.github/workflows/docs.yaml
132134
secrets: inherit
133135
with:
134136
version: ${{ needs.publish.outputs.tag }}
135137
alias: latest
136138
set-default: true
139+
ref: ${{ needs.publish.outputs.tag }}
137140
push: true

0 commit comments

Comments
 (0)