Skip to content
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.

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

chore(ci): Build docs #78

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

Conversation

KyleFromNVIDIA
Copy link
Contributor

No description provided.

Copy link
Contributor

@bdice bdice left a comment

Choose a reason for hiding this comment

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

Can we make the docs build into a separate CI job, and end with calling rapids-upload-docs? Try to mirror this script: https://github.com/rapidsai/cudf/blob/branch-24.06/ci/build_docs.sh

Then we'll be able to preview the docs as CI artifacts.

@ajschmidt8
Copy link
Member

Can we make the docs build into a separate CI job, and end with calling rapids-upload-docs? Try to mirror this script: https://github.com/rapidsai/cudf/blob/branch-24.06/ci/build_docs.sh

Then we'll be able to preview the docs as CI artifacts.

There's a few things to be aware of here.

rapids-upload-docs requires AWS credentials to upload to S3.

We use this OIDC action to obtain temporary AWS credentials https://github.com/aws-actions/configure-aws-credentials/.

That action requires that the id-token permission on the calling workflow be set to write.

However, when using the pull_request event to trigger workflows from forks, that permission can only ever have a maximum permission of read: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token.

Therefore if you want to set id-token: write, you'll need to either move away from using forked PRs (e.g. open PRs from branches within the source repository) or switch to copy-pr-bot, which is how we get away with it in other RAPIDS libraries.

.github/workflows/build-test.yaml Outdated Show resolved Hide resolved
ci/build_docs.sh Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants