From c154131d66f9177e5e5196995af82701c27749a6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=BAben=20Fonseca?= Date: Thu, 20 Oct 2022 11:18:01 +0200 Subject: [PATCH 1/4] feat(ci): release docs as alpha when doing a pre-release --- .github/workflows/on_release_notes.yml | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/.github/workflows/on_release_notes.yml b/.github/workflows/on_release_notes.yml index 8d6754b88a0..040e7fe512f 100644 --- a/.github/workflows/on_release_notes.yml +++ b/.github/workflows/on_release_notes.yml @@ -44,6 +44,11 @@ on: default: false type: boolean required: false + pre_release: + description: "Publishes documentation using a pre-release tag. You are still responsible for passing a pre-release version tag to the workflow." + default: false + type: boolean + required: false jobs: release: @@ -113,15 +118,30 @@ jobs: contents: write uses: ./.github/workflows/reusable_publish_changelog.yml + # When we're doing a pre-release, we want to publish the docs as alpha + prepare-docs-alias: + runs-on: ubuntu-latest + outputs: + DOCS_ALIAS: ${{ steps.set-alias.outputs.DOCS_ALIAS }} + steps: + - name: Set docs alias + id: set-alias + run: | + DOCS_ALIAS=latest + if [[ "${{ github.event.release.prerelease || inputs.pre_release }}" == true ]] ; then + DOCS_ALIAS="alpha" + fi + echo DOCS_ALIAS="$DOCS_ALIAS" >> "$GITHUB_OUTPUT" + docs: - needs: [release, changelog] + needs: [release, changelog, prepare-docs-alias] permissions: contents: write pages: write uses: ./.github/workflows/reusable_publish_docs.yml with: version: ${{ needs.release.outputs.RELEASE_VERSION }} - alias: latest + alias: ${{ needs.prepare-docs-alias.outputs.DOCS_ALIAS }} detached_mode: true publish_layer: From b211dd5f4dd98b023708a2f0cb9abe0482662a17 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=BAben=20Fonseca?= Date: Thu, 20 Oct 2022 11:24:07 +0200 Subject: [PATCH 2/4] fix: wording --- .github/workflows/on_release_notes.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/on_release_notes.yml b/.github/workflows/on_release_notes.yml index 040e7fe512f..78d21846be5 100644 --- a/.github/workflows/on_release_notes.yml +++ b/.github/workflows/on_release_notes.yml @@ -118,7 +118,7 @@ jobs: contents: write uses: ./.github/workflows/reusable_publish_changelog.yml - # When we're doing a pre-release, we want to publish the docs as alpha + # When doing a pre-release, we want to publish the docs as "alpha" instead of replacing the latest docs prepare-docs-alias: runs-on: ubuntu-latest outputs: From 2fe9e645b829c98834767068918cc3c12a2b0cb8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=BAben=20Fonseca?= Date: Thu, 20 Oct 2022 11:56:30 +0200 Subject: [PATCH 3/4] fix: wording --- .github/workflows/on_release_notes.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/on_release_notes.yml b/.github/workflows/on_release_notes.yml index 78d21846be5..734ce8c2f05 100644 --- a/.github/workflows/on_release_notes.yml +++ b/.github/workflows/on_release_notes.yml @@ -129,7 +129,7 @@ jobs: run: | DOCS_ALIAS=latest if [[ "${{ github.event.release.prerelease || inputs.pre_release }}" == true ]] ; then - DOCS_ALIAS="alpha" + DOCS_ALIAS=alpha fi echo DOCS_ALIAS="$DOCS_ALIAS" >> "$GITHUB_OUTPUT" From 5b5b62e45df78ef2953a99f04816075a3a9ef48a Mon Sep 17 00:00:00 2001 From: Ruben Fonseca Date: Thu, 20 Oct 2022 13:02:46 +0200 Subject: [PATCH 4/4] fix: apply suggestions from code review Co-authored-by: Heitor Lessa --- .github/workflows/on_release_notes.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/on_release_notes.yml b/.github/workflows/on_release_notes.yml index 734ce8c2f05..71c9d07c930 100644 --- a/.github/workflows/on_release_notes.yml +++ b/.github/workflows/on_release_notes.yml @@ -119,7 +119,7 @@ jobs: uses: ./.github/workflows/reusable_publish_changelog.yml # When doing a pre-release, we want to publish the docs as "alpha" instead of replacing the latest docs - prepare-docs-alias: + prepare_docs_alias: runs-on: ubuntu-latest outputs: DOCS_ALIAS: ${{ steps.set-alias.outputs.DOCS_ALIAS }} @@ -134,14 +134,14 @@ jobs: echo DOCS_ALIAS="$DOCS_ALIAS" >> "$GITHUB_OUTPUT" docs: - needs: [release, changelog, prepare-docs-alias] + needs: [release, changelog, prepare_docs_alias] permissions: contents: write pages: write uses: ./.github/workflows/reusable_publish_docs.yml with: version: ${{ needs.release.outputs.RELEASE_VERSION }} - alias: ${{ needs.prepare-docs-alias.outputs.DOCS_ALIAS }} + alias: ${{ needs.prepare_docs_alias.outputs.DOCS_ALIAS }} detached_mode: true publish_layer: