Skip to content

code: add published doc link in the Actions UI #230

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

Open
vibhoraggarwal wants to merge 5 commits into
base: main
Choose a base branch
from
Open

code: add published doc link in the Actions UI #230

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
79c1471
code: add published doc link in the Actions UI
av-etas Sep 7, 2026
42b4a09
: code: environment publishing needs permission, publish to summary i…
av-etas Sep 9, 2026
f44861a
code: publish the url depending on the output folder selection based …
av-etas Sep 9, 2026
296626b
: code: using deploy step for custom urls
av-etas Sep 9, 2026
d0ce6fc
code: update the links with environment variable
av-etas Sep 17, 2026
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
12 changes: 11 additions & 1 deletion .github/workflows/docs-publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,14 @@ jobs:
with:
artifact_name: ${{ env.PAGES_ARTIFACT_NAME }}

- 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 "${{ env.DOCUMENTATION_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
Expand All @@ -312,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 }}**: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/${{ steps.target.outputs.folder }}/
**${{ steps.target.outputs.folder }}**: ${{ env.DOCUMENTATION_URL }}