Skip to content

feat: 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

Merged
AlexanderLanin merged 8 commits into from
Oct 13, 2026
Merged

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

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c5f0ea0
code: add published doc link in the Actions UI
av-etas Sep 7, 2026
0e229d5
: code: environment publishing needs permission, publish to summary i…
av-etas Sep 9, 2026
6e7ccd7
code: publish the url depending on the output folder selection based …
av-etas Sep 9, 2026
b2be65c
: code: using deploy step for custom urls
av-etas Sep 9, 2026
fe9b687
code: update the links with environment variable
av-etas Sep 17, 2026
df0a959
docs: publish summary URL for legacy deployments
vibhoraggarwal Oct 1, 2026
69f6293
Merge branch 'main' into feature/add-url-to-the-action-UI
vibhoraggarwal Oct 9, 2026
24d3985
Merge branch 'main' into feature/add-url-to-the-action-UI
vibhoraggarwal Oct 13, 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
18 changes: 17 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 @@ -311,6 +311,22 @@ jobs:
with:
artifact_name: ${{ env.PAGES_ARTIFACT_NAME }}

- name: Resolve documentation URL
if: steps.metadata.outputs.should_deploy == 'true'
id: documentation-url
env:
PAGES_BASE_URL: ${{ steps.deploy-pages.outputs.page_url || format('https://{0}.github.io/{1}/', github.repository_owner, github.event.repository.name) }}
TARGET_FOLDER: ${{ steps.target.outputs.folder }}
run: echo "url=${PAGES_BASE_URL%/}/${TARGET_FOLDER}/" >> "$GITHUB_OUTPUT"

- name: Post deployment URL to summary
if: steps.metadata.outputs.should_deploy == 'true'
env:
DOCUMENTATION_URL: ${{ steps.documentation-url.outputs.url }}
run: |
echo "### Documentation published" >> "$GITHUB_STEP_SUMMARY"
echo "$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 @@ -327,4 +343,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.documentation-url.outputs.url }}
Loading