Add doc preview CI

[leofang]

Close #346.

This PR adds a new doc_preview action that deploys docs built in each PR to

https://nvidia.github.io/cuda-python/pr-preview/pr-<id>/

and post a message. Upon PR merge, the action would clean up the pushed files to remove the preview.

The doc_preview largely follows the logic of pr-preview-action, but has to be re-implemented to cope with two limitations:

1. Our copy-pr-bot can only be triggered by a push event, not by pull_request or pull_request_target events as required by pr-preview-action
2. The upstream pr-preview-action has no plan to support taking a PR number as an input parameter to bypass the first limitation (see Add doc preview CI #380 (comment))

It is understandable why pull_request* events are preferred, because with push events it is very tricky to get the PR number robustly, both during the PR test stage and during the merge to the main branch, and in the end this is what we need:

• PR test stage:
  • use get-pr-info provided by nv-gha-runners to get the PR number
  • deploy the preview
• Merge to main:
  • use the listPullRequestsAssociatedWithCommit GitHub API to get the PR number
  • clean up the preview

[copy-pr-bot]

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

[leofang]

/ok to test

[leofang]

Looks like we need the org admin to approve another action. Waiting for response.

[leofang]

Looks like we need the org admin to approve another action. Waiting for response.

Admin has approved. Let's retry...

[leofang]

/ok to test

[leofang]

/ok to test

[leofang]

/ok to test

[leofang]

The action worked, but the way we launched it is not right. It couldn't get the PR number, so

• the pushed htmls are placed under the pr- folder instead of pr-380: 612403f, https://nvidia.github.io/cuda-python/pr-preview/pr-/latest/
• the action could not leave a comment in the PR: https://github.com/NVIDIA/cuda-python/actions/runs/12751404575/job/35539015500#step:16:207

[leofang]

It couldn't get the PR number

Discussed with the upstream maintainer (rossjrw/pr-preview-action#101), and unfortunately we'll have to be creative here. Luckily we have most things set up in the doc-build workflow, so we just need to check in the doc artifacts to the gh-pages branch and push.

[leofang]

/ok to test

[leofang]

/ok to test

[leofang]

/ok to test

[leofang]

/ok to test

[leofang]

/ok to test

[leofang]

note to self: when using this API to check the PR number
https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#list-pull-requests-associated-with-a-commit
the owner field is not the repo that the PR targets, but the repo that the PR originates from (in this case, mine). However, when the CI is triggered via the push event by the copy-pr-bot, I feel this info is lost and I can't retrieve it...

[leofang]

/ok to test

[leofang]

Seems to work now!
https://nvidia.github.io/cuda-python/pr-preview/pr-380/latest/

[leofang]

/ok to test

[leofang]

/ok to test

[leofang]

/ok to test

[leofang]

/ok to test

[leofang]

/ok to test

[leofang]

(PR description updated)

[leofang]

/ok to test

[leofang]

/ok to test

[leofang]

Can anyone approve again? Let's merge and check if the cleanup happens as expected, and then we can use this in other doc PRs.

[github-actions]

Doc Preview CI
Preview removed because the pull request was closed or merged.

[leofang]

Verified the clean-up works too! 3db2f0c