Skip to content

add docs on CI workflow inputs - #1075

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

add docs on CI workflow inputs#1075
rapids-bot[bot] merged 2 commits into
NVIDIA: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

@jameslambjameslamb added doc Improvements or additions to documentation non-breaking Introduces a non-breaking change labels Jul 1, 2025
@copy-pr-bot

Copy link
Copy Markdown

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
MemberAuthor

/ok to test

@jameslamb

Copy link
Copy Markdown
MemberAuthor

/ok to test

@jameslambjameslamb changed the title WIP: add docs on CI workflow inputsadd docs on CI workflow inputsJul 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 ownerJuly 1, 2025 15:49
@jameslamb

Copy link
Copy Markdown
MemberAuthor

/merge

@rapids-bot
rapids-botBot merged commit 3f40c06 into NVIDIA:branch-25.08Jul 1, 2025
@jameslamb
jameslamb deleted the docs/input-descriptions branch July 1, 2025 22:18
landrumb pushed a commit to landrumb/cuvs that referenced this pull request Jul 8, 2026
Contributes to rapidsai/shared-workflows#376
* adds descriptions for all inputs to workflows triggered by `workflow_dispatch`
Contributes to rapidsai/shared-workflows#379
* removes input `enable_check_symbols` for `conda-cpp-checks` workflow... no longer needed as of rapidsai/shared-workflows#382
## Notes for Reviewers
### Motivation
The input descriptions show up in the UI when you go to trigger these workflows. Like this:
![image](https://github.com/user-attachments/assets/fc62d1ff-39eb-47c7-9a21-57aab959e64f)
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
Authors:
- James Lamb (https://github.com/jameslamb)
Approvers:
- Vyas Ramasubramani (https://github.com/vyasr)
URL: NVIDIA#1075
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docImprovements or additions to documentationnon-breakingIntroduces a non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jameslamb@vyasr