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

Set up a preliminary doc build/publish pipeline #325

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

Conversation

leofang
Copy link
Member

@leofang leofang commented Dec 28, 2024

For now this only updates the "latest" docs, reflecting the changes made in the main branch. This is consistent with the behavior of most versioned docs.

Part of #169.

@leofang leofang added documentation Improvements or additions to documentation P0 High priority - Must do! CI/CD CI/CD infrastructure labels Dec 28, 2024
@leofang leofang added this to the cuda.core beta 3 milestone Dec 28, 2024
@leofang leofang self-assigned this Dec 28, 2024
Copy link

copy-pr-bot bot commented Dec 28, 2024

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.

@leofang
Copy link
Member Author

leofang commented Dec 28, 2024

/ok to test

@leofang
Copy link
Member Author

leofang commented Dec 28, 2024

/ok to test

@leofang
Copy link
Member Author

leofang commented Dec 28, 2024

/ok to test

@leofang
Copy link
Member Author

leofang commented Dec 28, 2024

/ok to test

1 similar comment
@leofang
Copy link
Member Author

leofang commented Dec 28, 2024

/ok to test

@leofang
Copy link
Member Author

leofang commented Dec 28, 2024

/ok to test

1 similar comment
@leofang
Copy link
Member Author

leofang commented Dec 28, 2024

/ok to test

@leofang
Copy link
Member Author

leofang commented Dec 28, 2024

/ok to test

@leofang
Copy link
Member Author

leofang commented Dec 28, 2024

/ok to test

@leofang
Copy link
Member Author

leofang commented Dec 28, 2024

/ok to test

.github/workflows/ci-gh.yml Outdated Show resolved Hide resolved
.github/workflows/gh-build-docs.yml Outdated Show resolved Hide resolved
.github/workflows/gh-build-docs.yml Outdated Show resolved Hide resolved
id: build
run: |
pushd cuda_python/docs/
./build_all_docs.sh latest-only
Copy link
Member Author

Choose a reason for hiding this comment

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

Note: This workflow currently only builds the "latest" docs; those with release versions (ex: cuda.bindings 12.6.2) need a separate step that we should add in another PR (once we figure out the release workflow).

Copy link
Member Author

Choose a reason for hiding this comment

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

I think the logic should be as simple as (I could be wrong!)

  • Is the doc CI triggered by PRs or merging to main?
    • Yes: Only update latest
    • No: Assert this is triggered by a release. Update both latest and the latest release version.
      • TODO: check if we have a way to declare if we only want to update a certain component's docs.

@leofang
Copy link
Member Author

leofang commented Dec 28, 2024

/ok to test

@leofang
Copy link
Member Author

leofang commented Dec 28, 2024

This is ready for review (after the holidays!). The PR status is set to draft only because of #325 (comment).

@leofang
Copy link
Member Author

leofang commented Dec 28, 2024

/ok to test

@leofang leofang marked this pull request as ready for review December 28, 2024 23:59
@leofang
Copy link
Member Author

leofang commented Dec 29, 2024

/ok to test

Copy link
Member Author

Choose a reason for hiding this comment

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

FYI in commit 131e7b7 I nuked this file because of this last straw: I see the action panel is a bit messy
截圖 2024-12-30 上午12 24 12

@leofang
Copy link
Member Author

leofang commented Dec 30, 2024

/ok to test

@leofang
Copy link
Member Author

leofang commented Dec 30, 2024

/ok to test

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD CI/CD infrastructure documentation Improvements or additions to documentation P0 High priority - Must do!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant