Skip to content

docs: Simplify docs workflow build#7229

Closed
wence- wants to merge 1 commit intoNVIDIA:mainfrom
wence-:wence/fix/force-push-gh-pages
Closed

docs: Simplify docs workflow build#7229
wence- wants to merge 1 commit intoNVIDIA:mainfrom
wence-:wence/fix/force-push-gh-pages

Conversation

@wence-
Copy link
Contributor

@wence- wence- commented Jan 14, 2026

Description

The workflow build only runs on main, so cull a load of unnecessary steps.

Additionally, adapt the upload action to:

  1. Generate the requisite .nojekyll file
  2. Force push to the gh-pages branch

The latter will ensure (eventually, once git gc runs on the server) that the CCCL repo doesn't massively bloat with each docs deployment.

Similar to #1194

Checklist

  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

The workflow build only runs on main, so cull a load of unnecessary steps.

Additionally, adapt the upload action to:

1. Generate the requisite .nojekyll file
2. Force push to the gh-pages branch

The latter will ensure (eventually, once git gc runs on the server) that
the CCCL repo doesn't massively bloat with each docs deployment.
@wence- wence- requested a review from a team as a code owner January 14, 2026 16:07
@wence- wence- requested a review from jrhemstad January 14, 2026 16:07
@github-project-automation github-project-automation bot moved this to Todo in CCCL Jan 14, 2026
@copy-pr-bot
Copy link
Contributor

copy-pr-bot bot commented Jan 14, 2026

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.

@cccl-authenticator-app cccl-authenticator-app bot moved this from Todo to In Review in CCCL Jan 14, 2026
@miscco
Copy link
Contributor

miscco commented Jan 14, 2026

We once dreamed of a time where each PR would generate a documentation @jrhemstad what do you say?

@wence-
Copy link
Contributor Author

wence- commented Jan 14, 2026

We once dreamed of a time where each PR would generate a documentation @jrhemstad what do you say?

In rapids we do this by pushing the built site into an s3 bucket that we expose via html. e.g. see https://github.com/rapidsai/cudf/actions/runs/20975326181/job/60292097495?pr=21032#step:13:7664

That avoids polluting the gh-pages branch with commits for every PR.

The official github actions deploy-pages action has a preview option (https://github.com/actions/deploy-pages/blob/main/action.yml) but it is github internal only and has been in alpha preview for at least 4 years. (You can see it working e.g. github/opensource.guide#3583)

@wence-
Copy link
Contributor Author

wence- commented Feb 13, 2026

#5787 is a better version of this.

@wence- wence- closed this Feb 13, 2026
@github-project-automation github-project-automation bot moved this from In Review to Done in CCCL Feb 13, 2026
@wence- wence- deleted the wence/fix/force-push-gh-pages branch February 13, 2026 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

2 participants