Skip to content

add docs on CI workflow inputs#5139

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

add docs on CI workflow inputs#5139
rapids-bot[bot] merged 1 commit 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

@jameslamb jameslamb added doc Documentation non-breaking Non-breaking change labels Jul 1, 2025
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot bot commented Jul 1, 2025

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
Copy Markdown
Member Author

/ok to test

@jameslamb jameslamb changed the title WIP: add docs on CI workflow inputs add docs on CI workflow inputs Jul 1, 2025
@jameslamb jameslamb marked this pull request as ready for review July 1, 2025 15:49
@jameslamb jameslamb requested a review from a team as a code owner July 1, 2025 15:49
@jameslamb jameslamb requested a review from msarahan July 1, 2025 15:49
@jameslamb
Copy link
Copy Markdown
Member Author

/merge

@rapids-bot rapids-bot bot merged commit a24c52d into rapidsai:branch-25.08 Jul 1, 2025
65 checks passed
@jameslamb jameslamb deleted the docs/input-descriptions branch July 1, 2025 18:34
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