Skip to content

add docs on CI workflow inputs#19234

Merged
rapids-bot[bot] merged 2 commits intorapidsai:branch-25.08from
jameslamb:docs/input-descriptions
Jul 1, 2025
Merged

add docs on CI workflow inputs#19234
rapids-bot[bot] merged 2 commits intorapidsai:branch-25.08from
jameslamb:docs/input-descriptions

Conversation

@jameslamb
Copy link
Copy Markdown
Member

Description

Contributes to rapidsai/shared-workflows#376

  • adds descriptions for all inputs to workflows triggered by workflow_dispatch

Contributes to rapidsai/shared-workflows#379

Notes for Reviewers

Motivation

The input descriptions show up in the UI when you go to trigger these workflows. Like this:

image

I'm hoping that will make it easier for developers to manually trigger workflows. Inspired by being asked multiple times "what format is date supposed to be in?".

Removing enable_check_symbols here is a step towards completely removing that always-true input, as part of rapidsai/shared-workflows#379

Other repos?

This is the first of these PRs... let's use it to decide on phrasing that we like.

Once it's approved and merged, I'll open similar PRs across RAPIDS.

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@jameslamb jameslamb requested a review from a team as a code owner June 26, 2025 21:58
@jameslamb jameslamb requested a review from AyodeAwe June 26, 2025 21:58
@jameslamb jameslamb added doc Documentation improvement Improvement / enhancement to an existing function labels Jun 26, 2025
@jameslamb jameslamb added non-breaking Non-breaking change and removed improvement Improvement / enhancement to an existing function labels Jun 26, 2025
@jameslamb
Copy link
Copy Markdown
Member Author

/merge

@rapids-bot rapids-bot Bot merged commit 171a437 into rapidsai:branch-25.08 Jul 1, 2025
95 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants