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

Add docs build job #347

Merged
merged 38 commits into from
Feb 17, 2023
Merged

Conversation

AyodeAwe
Copy link
Contributor

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.

@AyodeAwe AyodeAwe added improvement Improves an existing functionality non-breaking Introduces a non-breaking change labels Jan 23, 2023
@AyodeAwe AyodeAwe marked this pull request as ready for review January 25, 2023 16:00
@AyodeAwe AyodeAwe requested a review from a team as a code owner January 25, 2023 16:00
@ajschmidt8 ajschmidt8 changed the title add docs_build step Add docs build job Jan 25, 2023
dependencies.yaml Outdated Show resolved Hide resolved
ci/build_docs.sh Outdated Show resolved Hide resolved
ci/build_docs.sh Outdated Show resolved Hide resolved
ci/build_docs.sh Outdated Show resolved Hide resolved
ci/build_docs.sh Outdated Show resolved Hide resolved
ci/build_docs.sh Outdated Show resolved Hide resolved
ci/build_docs.sh Outdated Show resolved Hide resolved
AyodeAwe and others added 14 commits January 29, 2023 09:56
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>
@AyodeAwe AyodeAwe changed the base branch from branch-23.02 to branch-23.04 February 1, 2023 15:49
docs/conf.py Outdated Show resolved Hide resolved
dependencies.yaml Outdated Show resolved Hide resolved
dependencies.yaml Outdated Show resolved Hide resolved
dependencies.yaml Outdated Show resolved Hide resolved
@AyodeAwe AyodeAwe requested a review from a team as a code owner February 10, 2023 14:27
bdice
bdice previously requested changes Feb 10, 2023
.github/workflows/build.yaml Outdated Show resolved Hide resolved
.github/workflows/pr.yaml Outdated Show resolved Hide resolved
dependencies.yaml Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
rapids-cmake/cython/create_modules.cmake Outdated Show resolved Hide resolved
rapids-cmake/cython/add_rpath_entries.cmake Outdated Show resolved Hide resolved
AyodeAwe and others added 7 commits February 14, 2023 10:35
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>
docs/conf.py Outdated Show resolved Hide resolved
.github/workflows/build.yaml Outdated Show resolved Hide resolved
docs/conf.py Show resolved Hide resolved
.github/workflows/build.yaml Outdated Show resolved Hide resolved
@@ -45,3 +45,13 @@ jobs:
branch: ${{ inputs.branch }}
date: ${{ inputs.date }}
sha: ${{ inputs.sha }}
docs-build:
if: ${{ startsWith(github.ref, 'refs/heads/branch-') }}
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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 to workflow_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

@ajschmidt8 ajschmidt8 dismissed bdice’s stale review February 17, 2023 03:16

changes have been addressed

@ajschmidt8
Copy link
Member

/merge

@rapids-bot rapids-bot bot merged commit f293b30 into rapidsai:branch-23.04 Feb 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement Improves an existing functionality non-breaking Introduces a non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants