Skip to content

doc changes for Github Artifacts - #593

Closed
jayavenkatesh19 wants to merge 19 commits into
rapidsai:mainfrom
jayavenkatesh19:main
Closed

doc changes for Github Artifacts#593
jayavenkatesh19 wants to merge 19 commits into
rapidsai:mainfrom
jayavenkatesh19:main

Conversation

@jayavenkatesh19

Copy link
Copy Markdown
Contributor

Build artifacts across CI workflows on RAPIDS are now available through Github Artifacts. These docs changes provide information for developers and maintainers on how to download and use these artifacts directly from Github without needing any VPN access like with downloads.rapids.ai

@vercel

vercel Bot commented Apr 14, 2025

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview May 2, 2025 10:50am

@netlify

netlify Bot commented Apr 14, 2025

Copy link
Copy Markdown

Deploy Preview for docs-rapids-ai ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 6b883ca
🔍 Latest deploy log https://app.netlify.com/sites/docs-rapids-ai/deploys/6814a34dbef0f00008806180
😎 Deploy Preview https://deploy-preview-593--docs-rapids-ai.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@ajschmidt8 ajschmidt8 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good from an initial pass!

Left a few comments.

Comment thread resources/github-actions.md Outdated
Comment thread resources/github-actions.md Outdated
Comment thread resources/github-actions.md Outdated
Comment thread resources/github-actions.md Outdated
Comment thread resources/github-actions.md Outdated
Comment thread resources/github-actions.md Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The Limitations section on this page has a few S3 references that should be updated as well.

@jayavenkatesh19 jayavenkatesh19 Apr 15, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The references in that section primarily refer to downloads. Considering we didn't switch over downloads just yet, I did not change those sections of the documentation. Let me know if you want me to preemptively change them.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think you can preemptively make those changes. I assume we won't merge any of these doc updates until after all of the repository PRs are completely merged.

jayavenkatesh19 and others added 7 commits April 15, 2025 15:19
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>
Comment thread resources/reproducing-ci.md Outdated
Comment thread resources/reproducing-ci.md Outdated

@pentschev pentschev left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I would like more details about running when gh is not available, for example when developing on a remote machine. Can we make adjustments to provide instructions for those cases?

Comment thread resources/reproducing-ci.md Outdated
rapidsai/ci-conda:cuda11.8.0-ubuntu22.04-py3.10
```

Note: The `--env GITHUB_TOKEN=$(gh auth token)` flag is required to authenticate with GitHub for accessing artifacts. This token is automatically generated from your GitHub CLI authentication and passed to the container. Make sure you have the GitHub CLI (`gh`) installed and authenticated on your host machine.

@pentschev pentschev Apr 28, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

What if I'm working on a remote machine where gh isn't installed? Can I pass a custom GH token? What permissions do I need at a minimum to prevent the need for a token with too broad scope (and thus reduce security concerns)? Could we document that?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'll get all of this into docs in the replacement PR (#601), but to answer here:

What if I'm working on a remote machine where gh isn't installed?

The CI images come with the gh CLI installed already and the relevant gha-tools tools will now prompt you to login interactively if it looks like you haven't authenticated with GitHub.

See rapidsai/gha-tools#172

That interactive auth will last for as long as the container stays up, and won't leave any credentials behind on the system you ran docker run from.

Can I pass a custom GH token? What permissions do I need at a minimum to prevent the need for a token with too broad scope (and thus reduce security concerns)?

Yes, you can provide a GitHub personal access token in the GH_TOKEN environment variable for any processes using the gh CLI to pull these artifacts.

It only needs the repo scope (see "How I tested this" in the description of rapidsai/gha-tools#172)

Could we document that?

Yes, I'll explain these topics in #601

@jayavenkatesh19 jayavenkatesh19 changed the title WIP: doc changes for Github Artifacts doc changes for Github Artifacts May 2, 2025
@jayavenkatesh19
jayavenkatesh19 marked this pull request as ready for review May 2, 2025 10:52
@jayavenkatesh19
jayavenkatesh19 requested a review from a team as a code owner May 2, 2025 10:53

@bdice bdice left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@ajschmidt8 I see you have some comments about when this is appropriate to merge. Everything looks fine to me. Please merge when you are ready.

@bdice
bdice requested a review from pentschev May 2, 2025 21:19
@jameslamb

Copy link
Copy Markdown
Member

I'm putting this back into draft. I'd like to resolve the open questions around auth (maybe accompanied by changes like rapidsai/gha-tools#168 or similar) before merging. I am working on this right now.

@jameslamb

Copy link
Copy Markdown
Member

Could someone with write access here (@bdice ?) please close this?

I'd like to continue this work in a separate PR: #601

Why a new PR?

  • not having write access means I can't push changes to this PR
  • even if I did have write access here, this coming from main on a fork makes merging in recent changes in this repo kind of tricky

@bdice

bdice commented May 14, 2025

Copy link
Copy Markdown
Contributor

Closing as requested.

@bdice bdice closed this May 14, 2025
@jameslamb

Copy link
Copy Markdown
Member

Thank you! I do now have write access here, shouldn't have to bug you for that again 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants