-
Notifications
You must be signed in to change notification settings - Fork 46
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
Add docs build job #347
Add docs build job #347
Conversation
6e3b7a1
to
cc3111c
Compare
Co-authored-by: AJ Schmidt <ajschmidt8@users.noreply.github.com>
Co-authored-by: AJ Schmidt <ajschmidt8@users.noreply.github.com>
Co-authored-by: AJ Schmidt <ajschmidt8@users.noreply.github.com>
Co-authored-by: AJ Schmidt <ajschmidt8@users.noreply.github.com>
Co-authored-by: AJ Schmidt <ajschmidt8@users.noreply.github.com>
Co-authored-by: AJ Schmidt <ajschmidt8@users.noreply.github.com>
Co-authored-by: AJ Schmidt <ajschmidt8@users.noreply.github.com>
update docs step to use a branch-23.04 Co-authored-by: Bradley Dice <bdice@bradleydice.com>
update docs step to use a branch-23.04 Co-authored-by: Bradley Dice <bdice@bradleydice.com>
Co-authored-by: Bradley Dice <bdice@bradleydice.com>
Co-authored-by: Bradley Dice <bdice@bradleydice.com>
Co-authored-by: Bradley Dice <bdice@bradleydice.com>
Co-authored-by: Bradley Dice <bdice@bradleydice.com>
.github/workflows/build.yaml
Outdated
@@ -45,3 +45,13 @@ jobs: | |||
branch: ${{ inputs.branch }} | |||
date: ${{ inputs.date }} | |||
sha: ${{ inputs.sha }} | |||
docs-build: | |||
if: ${{ startsWith(github.ref, 'refs/heads/branch-') }} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if: ${{ startsWith(github.ref, 'refs/heads/branch-') }} | |
if: github.ref_type == 'branch' && github.event_name == 'push' |
I just discovered this problem that we'll need to update in all of the docs build PRs that have already been merged.
We need to change this conditional so that this job doesn't run as part of the nightly builds.
The docs builds aren't intended to run as part of the nightly jobs, so they're currently breaking the nightly builds (see cuml nightly job here for reference).
We can update this conditional as shown here to:
- simplify the
branch
assertion - ensure that it only runs on
push
events (as opposed toworkflow_dispatch
events which trigger the nightlies).
After this PR is merged, we can test that this conditional works correctly and then roll out the fix to other repositories.
cc: @AjayThorve
/merge |
The PR adds a
docs_build
process to the PR and Build workflows for this repository. The generated docs are synced to s3 for only the build workflows.