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

build libwholegraph docs in CI #96

Merged
merged 8 commits into from
Dec 17, 2024

Conversation

jameslamb
Copy link
Member

@jameslamb jameslamb commented Dec 16, 2024

Fixes #94

Uploads API docs for libwholegraph, to be used by rapidsai/cugraph-docs#46

Also removes sphinx dependencies... this repo only needs to produce Doxygen docs for libwholegraph, all the other Sphinx stuff will be done in https://github.com/rapidsai/cugraph-docs.

@jameslamb jameslamb added doc Improvements or additions to documentation non-breaking Introduces a non-breaking change labels Dec 16, 2024
Copy link

copy-pr-bot bot commented Dec 16, 2024

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@jameslamb
Copy link
Member Author

/ok to test

@jameslamb
Copy link
Member Author

/ok to test

@jameslamb
Copy link
Member Author

/ok to test

@jameslamb jameslamb changed the title WIP: build libwholegraph docs in CI build libwholegraph docs in CI Dec 16, 2024
@jameslamb jameslamb marked this pull request as ready for review December 16, 2024 21:57
@jameslamb jameslamb requested review from a team as code owners December 16, 2024 21:57
@jameslamb jameslamb requested review from bdice and acostadon December 16, 2024 21:57
@jameslamb
Copy link
Member Author

Looks like this is working as expected:

upload: ../../../tmp/tmp.M6YZWJmdr3/libwholegraph/xml_tar/xml.tar.gz to s3://rapids-downloads/ci/cugraph-gnn/pull-request/96/ef0cedc/docs/libwholegraph/xml_tar/xml.tar.gz

(build link)

Copy link

@acostadon acostadon left a comment

Choose a reason for hiding this comment

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

Looks great

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.

One suggestion to use rapidsai/ci-conda:latest -- but otherwise approving.

arch: "amd64"
branch: ${{ inputs.branch }}
build_type: ${{ inputs.build_type || 'branch' }}
container_image: "rapidsai/ci-conda:cuda12.5.1-ubuntu22.04-py3.11"
Copy link
Contributor

@bdice bdice Dec 17, 2024

Choose a reason for hiding this comment

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

Can we use the latest tag? I think it's an oversight that we are not currently using rapidsai/ci-conda:latest for all our docs builds. We switched to a specific tag for a short time during the Python 3.12 migration, but now we should be able to use latest again. (Don't block on this if this PR is holding up other work.)

Copy link
Member Author

Choose a reason for hiding this comment

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

cugraph actually is using :latest and I intentionally chose a specific tag here (though should have picked Python 3.12, that's an oversight).

I was thinking that a specific tag is helpful to be improve the probability that a branch is buildable for hotfixes even a few weeks after a release, if ci-conda:latest by that time points to a CUDA version or operating system or Python version that that release didn't support.

The tradeoff is that you get things like my mistake here, where the image being used isn't the latest one that the library could support.

Given that, do you still think :latest?

Don't block on this if this PR is holding up other work.

Yeah we need this PR in to proceed with cugraph-docs, so I'll merge it whenever the next CI builds passes and put up a follow-up with whatever consensus we reach on the image tag.

Copy link
Contributor

Choose a reason for hiding this comment

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

It doesn’t really matter. If you want to pin it, that is fine, but we just need to be responsible for keeping those pins up to date. We also drop versions all the time (we may not need 12.5.1 in our test matrix at some future time) which can break this without warning. There is always a latest tag.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah fair point. Changed my mind about waiting for a follow-up PR... jobs weren't actually that far along yet so I just pushed this change here: 5df836b

@jameslamb
Copy link
Member Author

/merge

@rapids-bot rapids-bot bot merged commit cc1bab9 into rapidsai:branch-25.02 Dec 17, 2024
81 checks passed
@jameslamb jameslamb deleted the ci/docs-build branch December 17, 2024 19:08
rapids-bot bot pushed a commit that referenced this pull request Dec 17, 2024
The branch build triggered by merging #96 failed immediately.

> The workflow is not valid. .github/workflows/build.yaml (Line: 47, Col: 12): Job 'docs-build' depends on unknown job 'conda-cpp-build'.

([build link](https://github.com/rapidsai/cugraph-gnn/actions/runs/12379736454))

This fixes that.

Authors:
  - James Lamb (https://github.com/jameslamb)

Approvers:
  - Don Acosta (https://github.com/acostadon)
  - Bradley Dice (https://github.com/bdice)

URL: #97
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation non-breaking Introduces a non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

XML Docs for wholegraph needs to be created and uploaded in ci for use by cugraph-docs repository
3 participants