Skip to content

Fix fork PR docs workflow #2910

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
antonwolfy wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Fix fork PR docs workflow #2910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
eb159a8
Fix fork PR detection in build-sphinx workflow
antonwolfy May 11, 2026
9975677
Add fork PR detection and artifact upload
antonwolfy May 11, 2026
e85f3ab
Add PR comments for documentation preview
antonwolfy May 11, 2026
5c3b452
Remove redundant GH_EVENT_OPEN_PR_UPSTREAM variable
antonwolfy May 11, 2026
56fe652
Skip PR comments for fork PRs due to token restrictions
antonwolfy May 11, 2026
63b2ded
Add GH_EVENT_PR_OPEN environment variable for cleaner conditions
antonwolfy May 11, 2026
05cc1cb
Add to the changelog
antonwolfy May 11, 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
31 changes: 26 additions & 5 deletions .github/workflows/build-sphinx.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,9 @@ permissions: read-all
env:
GH_BOT_NAME: 'github-actions[bot]'
GH_BOT_EMAIL: 'github-actions[bot]@users.noreply.github.com'
GH_EVENT_OPEN_PR_UPSTREAM: ${{ github.event_name == 'pull_request' && github.event.action != 'closed' &&
github.event.pull_request && !github.event.pull_request.base.repo.fork }}
GH_EVENT_PUSH_UPSTREAM: ${{ github.ref == 'refs/heads/master' && github.event_name == 'push' &&
github.event.ref == 'refs/heads/master' && github.event.repository && !github.event.repository.fork }}
GH_EVENT_PR_OPEN: ${{ github.event_name == 'pull_request' && github.event.action != 'closed' }}
PUBLISH_DIR: doc/_build/html/

defaults:
Expand Down Expand Up @@ -191,6 +190,26 @@ jobs:
- name: Copy backend docs
run: cp -r dpnp/backend/doc/html ${{ env.PUBLISH_DIR }}/backend_doc

# Detect if this is a fork PR
Copy link
Copy Markdown
Contributor

@vlad-perevezentsev vlad-perevezentsev May 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was a separate step added for that?
Would it be simpler to use a workflow env variable directly?

GH_EVENT_PR_FORK: ${{ github.event_name == 'pull_request' &&
                      github.event.action != 'closed' &&
                      github.event.pull_request.head.repo.fork }}

- name: Check if fork PR
id: check_fork
run: |
IS_FORK="false"
if [ "${{ github.event_name }}" == "pull_request" ] && [ "${{ github.event.pull_request.head.repo.fork }}" == "true" ]; then
IS_FORK="true"
fi
echo "is_fork=$IS_FORK" >> "$GITHUB_OUTPUT"
echo "Is fork PR: $IS_FORK"

# Upload artifact for fork PRs
- name: Upload docs artifact (Fork PRs)
if: env.GH_EVENT_PR_OPEN == 'true' && steps.check_fork.outputs.is_fork == 'true'
uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3
with:
name: pr-${{ github.event.number }}-docs
path: ${{ env.PUBLISH_DIR }}
retention-days: 30

# The step is only used to build docs while pushing a PR to "master"
- name: Deploy docs
if: env.GH_EVENT_PUSH_UPSTREAM == 'true'
Expand All @@ -206,7 +225,7 @@ jobs:

# The step is only used to build docs while pushing to PR branch
- name: Publish pull-request docs
if: env.GH_EVENT_OPEN_PR_UPSTREAM == 'true'
if: env.GH_EVENT_PR_OPEN == 'true' && steps.check_fork.outputs.is_fork == 'false'
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -220,8 +239,10 @@ jobs:
user_email: ${{ env.GH_BOT_EMAIL }}

# The step is only used to build docs while pushing to PR branch
# Note: Fork PRs have read-only GITHUB_TOKEN and cannot post comments
# See: https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#workflows-in-forked-repositories
- name: Comment with URL to published pull-request docs
if: env.GH_EVENT_OPEN_PR_UPSTREAM == 'true'
if: env.GH_EVENT_PR_OPEN == 'true' && steps.check_fork.outputs.is_fork == 'false'
env:
PR_NUM: ${{ github.event.number }}
uses: mshick/add-pr-comment@8e4927817251f1ff60c001f04568532b38e0b4a0 # v3.11.0.8.3.11.0
Expand All @@ -235,7 +256,7 @@ jobs:
clean:
if: |
github.event_name == 'pull_request' && github.event.action == 'closed' &&
github.event.pull_request && !github.event.pull_request.base.repo.fork
github.event.pull_request.head.repo && !github.event.pull_request.head.repo.fork

needs: build-and-deploy

Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

* Fixed incorrect in-place advanced indexing for 4D arrays when using `range` or `list` as index keys [#2872](https://github.com/IntelPython/dpnp/pull/2872)
* Fixed `conda build` command syntax in GitHub workflows and documentation to use `conda-build` [#2888](https://github.com/IntelPython/dpnp/pull/2888)
* Fixed fork PR documentation workflow failures by implementing conditional publishing strategy: upstream PRs publish to GitHub Pages with comment, fork PRs upload artifacts [#2910](https://github.com/IntelPython/dpnp/pull/2910)

### Security

Expand Down
Loading