Skip to content

Commit 0e74f56

Browse files
authored
add docs on CI workflow inputs (#239)
Contributes to rapidsai/shared-workflows#376 * adds descriptions for all inputs to workflows triggered by `workflow_dispatch` ## 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?". Authors: - James Lamb (https://github.com/jameslamb) Approvers: - Jacob Tomlinson (https://github.com/jacobtomlinson) - Vyas Ramasubramani (https://github.com/vyasr) URL: #239
1 parent 7cdc778 commit 0e74f56

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

.github/workflows/build.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,21 @@ on:
1010
workflow_dispatch:
1111
inputs:
1212
branch:
13+
description: |
14+
branch: git branch the workflow run targets.
15+
Required even when 'sha' is provided because it is also used for organizing artifacts.
1316
required: true
1417
type: string
1518
date:
19+
description: "date: Date (YYYY-MM-DD) this run is for. Used to organize artifacts produced by nightly builds"
1620
required: true
1721
type: string
1822
sha:
23+
description: "sha: full git commit SHA to check out"
1924
required: true
2025
type: string
2126
build_type:
27+
description: "build_type: one of [branch, nightly, pull-request]"
2228
type: string
2329
default: nightly
2430

0 commit comments

Comments
 (0)