From 79c1471293ce0f34ecc5a6ee63a85856c193ca3f Mon Sep 17 00:00:00 2001 From: agv2fe Date: Tue, 8 Sep 2026 00:27:38 +0200 Subject: [PATCH 1/5] code: add published doc link in the Actions UI --- .github/workflows/docs-publish.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/docs-publish.yml b/.github/workflows/docs-publish.yml index 9879320..59d9a20 100644 --- a/.github/workflows/docs-publish.yml +++ b/.github/workflows/docs-publish.yml @@ -87,6 +87,9 @@ jobs: id-token: write # to verify the deployment originates from an appropriate source contents: write # to update versions.json and commit to gh-pages pull-requests: write # to comment on PRs with preview link + environment: + name: github-pages + url: ${{ steps.deploy-pages.outputs.page_url }} runs-on: ${{ inputs.runner-labels && fromJSON(inputs.runner-labels) || vars.runner_labels_ghub_standard_x64 && fromJSON(vars.runner_labels_ghub_standard_x64) || vars.REPO_RUNNER_LABELS && fromJSON(vars.REPO_RUNNER_LABELS) || 'ubuntu-latest' }} steps: - name: Resolve build metadata From 42b4a0941c8c7cff1ed61d80fd631cfc671526db Mon Sep 17 00:00:00 2001 From: agv2fe Date: Wed, 9 Sep 2026 11:23:50 +0200 Subject: [PATCH 2/5] : code: environment publishing needs permission, publish to summary instead --- .github/workflows/docs-publish.yml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs-publish.yml b/.github/workflows/docs-publish.yml index 59d9a20..9587fcb 100644 --- a/.github/workflows/docs-publish.yml +++ b/.github/workflows/docs-publish.yml @@ -87,9 +87,6 @@ jobs: id-token: write # to verify the deployment originates from an appropriate source contents: write # to update versions.json and commit to gh-pages pull-requests: write # to comment on PRs with preview link - environment: - name: github-pages - url: ${{ steps.deploy-pages.outputs.page_url }} runs-on: ${{ inputs.runner-labels && fromJSON(inputs.runner-labels) || vars.runner_labels_ghub_standard_x64 && fromJSON(vars.runner_labels_ghub_standard_x64) || vars.REPO_RUNNER_LABELS && fromJSON(vars.REPO_RUNNER_LABELS) || 'ubuntu-latest' }} steps: - name: Resolve build metadata @@ -303,6 +300,12 @@ jobs: with: artifact_name: ${{ env.PAGES_ARTIFACT_NAME }} + - name: Post deployment URL to summary + if: steps.deploy-pages.outputs.page_url != '' + run: | + echo "### Documentation published" >> $GITHUB_STEP_SUMMARY + echo "${{ steps.deploy-pages.outputs.page_url }}" >> $GITHUB_STEP_SUMMARY + - name: Find existing PR comment if: steps.metadata.outputs.should_deploy == 'true' && steps.metadata.outputs.pr_number != '' uses: peter-evans/find-comment@b30e6a3c0ed37e7c023ccd3f1db5c6c0b0c23aad # v4.0.0 From f44861acc42e23b55d544c323289b69d06bdb99e Mon Sep 17 00:00:00 2001 From: agv2fe Date: Wed, 9 Sep 2026 11:37:50 +0200 Subject: [PATCH 3/5] code: publish the url depending on the output folder selection based on branch or PR number --- .github/workflows/docs-publish.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-publish.yml b/.github/workflows/docs-publish.yml index 9587fcb..787ba30 100644 --- a/.github/workflows/docs-publish.yml +++ b/.github/workflows/docs-publish.yml @@ -304,7 +304,7 @@ jobs: if: steps.deploy-pages.outputs.page_url != '' run: | echo "### Documentation published" >> $GITHUB_STEP_SUMMARY - echo "${{ steps.deploy-pages.outputs.page_url }}" >> $GITHUB_STEP_SUMMARY + echo "https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/${{ steps.target.outputs.folder }}/" >> $GITHUB_STEP_SUMMARY - name: Find existing PR comment if: steps.metadata.outputs.should_deploy == 'true' && steps.metadata.outputs.pr_number != '' From 296626bfc07bfc4abd388cdd1872727f6b26f3ff Mon Sep 17 00:00:00 2001 From: agv2fe Date: Wed, 9 Sep 2026 11:50:22 +0200 Subject: [PATCH 4/5] : code: using deploy step for custom urls --- .github/workflows/docs-publish.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs-publish.yml b/.github/workflows/docs-publish.yml index 787ba30..58a0d28 100644 --- a/.github/workflows/docs-publish.yml +++ b/.github/workflows/docs-publish.yml @@ -304,7 +304,7 @@ jobs: if: steps.deploy-pages.outputs.page_url != '' run: | echo "### Documentation published" >> $GITHUB_STEP_SUMMARY - echo "https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/${{ steps.target.outputs.folder }}/" >> $GITHUB_STEP_SUMMARY + echo "${{ steps.deploy-pages.outputs.page_url }}${{ steps.target.outputs.folder }}/" >> $GITHUB_STEP_SUMMARY - name: Find existing PR comment if: steps.metadata.outputs.should_deploy == 'true' && steps.metadata.outputs.pr_number != '' @@ -322,4 +322,4 @@ jobs: issue-number: ${{ steps.metadata.outputs.pr_number }} body: | Documentation preview for this pull request is available at: - **${{ steps.target.outputs.folder }}**: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/${{ steps.target.outputs.folder }}/ + **${{ steps.target.outputs.folder }}**: ${{ steps.deploy-pages.outputs.page_url }}${{ steps.target.outputs.folder }}/ From d0ce6fc2283b789f31ef32a9766ecf1c0536b3be Mon Sep 17 00:00:00 2001 From: agv2fe Date: Thu, 17 Sep 2026 13:07:59 +0200 Subject: [PATCH 5/5] code: update the links with environment variable --- .github/workflows/docs-publish.yml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs-publish.yml b/.github/workflows/docs-publish.yml index 58a0d28..dcc4e9b 100644 --- a/.github/workflows/docs-publish.yml +++ b/.github/workflows/docs-publish.yml @@ -302,9 +302,11 @@ jobs: - name: Post deployment URL to summary if: steps.deploy-pages.outputs.page_url != '' + env: + DOCUMENTATION_URL: "${{ steps.deploy-pages.outputs.page_url }}${{ steps.target.outputs.folder }}/" run: | echo "### Documentation published" >> $GITHUB_STEP_SUMMARY - echo "${{ steps.deploy-pages.outputs.page_url }}${{ steps.target.outputs.folder }}/" >> $GITHUB_STEP_SUMMARY + echo "${{ env.DOCUMENTATION_URL }}" >> $GITHUB_STEP_SUMMARY - name: Find existing PR comment if: steps.metadata.outputs.should_deploy == 'true' && steps.metadata.outputs.pr_number != '' @@ -318,8 +320,10 @@ jobs: - name: Comment on PR with preview link if: steps.metadata.outputs.should_deploy == 'true' && steps.metadata.outputs.pr_number != '' && steps.fc.outputs.comment-id == '' uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0 + env: + DOCUMENTATION_URL: "${{ steps.deploy-pages.outputs.page_url || format('https://{0}.github.io/{1}/', github.repository_owner, github.event.repository.name) }}${{ steps.target.outputs.folder }}/" with: issue-number: ${{ steps.metadata.outputs.pr_number }} body: | Documentation preview for this pull request is available at: - **${{ steps.target.outputs.folder }}**: ${{ steps.deploy-pages.outputs.page_url }}${{ steps.target.outputs.folder }}/ + **${{ steps.target.outputs.folder }}**: ${{ env.DOCUMENTATION_URL }}