Skip to content

Commit 31f2e65

Browse files
authored
add docs on CI workflow inputs (rapidsai#164)
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: - Vyas Ramasubramani (https://github.com/vyasr) URL: rapidsai#164
1 parent c4bc864 commit 31f2e65

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

.github/workflows/build.yaml

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

.github/workflows/test.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,21 @@ on:
44
workflow_dispatch:
55
inputs:
66
branch:
7+
description: |
8+
branch: git branch the workflow run targets.
9+
Required even when 'sha' is provided because it is also used for organizing artifacts.
710
required: true
811
type: string
912
date:
13+
description: "date: Date (YYYY-MM-DD) this run is for. Used to organize artifacts produced by nightly builds"
1014
required: true
1115
type: string
1216
sha:
17+
description: "sha: full git commit SHA to check out"
1318
required: true
1419
type: string
1520
build_type:
21+
description: "build_type: one of [branch, nightly, pull-request]"
1622
type: string
1723
default: nightly
1824

0 commit comments

Comments
 (0)