Skip to content

Commit 11ae5a9

Browse files
feat(ci): release docs as alpha when doing a pre-release (#1624)
Co-authored-by: Heitor Lessa <[email protected]>
1 parent 4bba49c commit 11ae5a9

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

.github/workflows/on_release_notes.yml

+22-2
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,11 @@ on:
4444
default: false
4545
type: boolean
4646
required: false
47+
pre_release:
48+
description: "Publishes documentation using a pre-release tag. You are still responsible for passing a pre-release version tag to the workflow."
49+
default: false
50+
type: boolean
51+
required: false
4752

4853
jobs:
4954
release:
@@ -113,15 +118,30 @@ jobs:
113118
contents: write
114119
uses: ./.github/workflows/reusable_publish_changelog.yml
115120

121+
# When doing a pre-release, we want to publish the docs as "alpha" instead of replacing the latest docs
122+
prepare_docs_alias:
123+
runs-on: ubuntu-latest
124+
outputs:
125+
DOCS_ALIAS: ${{ steps.set-alias.outputs.DOCS_ALIAS }}
126+
steps:
127+
- name: Set docs alias
128+
id: set-alias
129+
run: |
130+
DOCS_ALIAS=latest
131+
if [[ "${{ github.event.release.prerelease || inputs.pre_release }}" == true ]] ; then
132+
DOCS_ALIAS=alpha
133+
fi
134+
echo DOCS_ALIAS="$DOCS_ALIAS" >> "$GITHUB_OUTPUT"
135+
116136
docs:
117-
needs: [release, changelog]
137+
needs: [release, changelog, prepare_docs_alias]
118138
permissions:
119139
contents: write
120140
pages: write
121141
uses: ./.github/workflows/reusable_publish_docs.yml
122142
with:
123143
version: ${{ needs.release.outputs.RELEASE_VERSION }}
124-
alias: latest
144+
alias: ${{ needs.prepare_docs_alias.outputs.DOCS_ALIAS }}
125145
detached_mode: true
126146

127147
publish_layer:

0 commit comments

Comments
 (0)