Description
Workflow inputs can have a description:
|
script: |
|
type: string |
|
required: true |
|
description: "Shell code to be executed in a step. Ideally this should just invoke a script managed in the repo the workflow runs from, like 'ci/build_cpp.sh'." |
Every input here should have one.
Benefits of this work
- makes it easier to understand the workflow files when you're reading them (for example, when configuring a new use of them in a repo)
- makes it easier to choose useful values when triggering with
workflow_dispatch in the UI (descriptions show up there)
Acceptance Criteria
- all inputs to the main RAPIDS workflows have informative descriptions
Approach
Add input descriptions for all of the workflows in this repo.
For longer notes, wrap like this:
|
description: | |
|
If provided, should contain the name of a secret in the repo which holds a GitHub API token. |
|
When this is non-empty, that secret's value is used in place of the default repo-level token |
|
anywhere that environment variable GH_TOKEN is set. |
Add descriptions at the callsites for these workflows across RAPIDS as well, for example:
https://github.com/rapidsai/cudf/blob/3e357c708d462b1df93b55a963d9e04973455da3/.github/workflows/build.yaml#L9-L22
Notes
Inspired by a recent discussion with @jakirkham , where we observed it requiring a couple of failed attempts to figure out the correct values to supply when manually re-triggering nightly test jobs.
Description
Workflow inputs can have a
description:shared-workflows/.github/workflows/conda-cpp-build.yaml
Lines 19 to 22 in c802825
Every input here should have one.
Benefits of this work
workflow_dispatchin the UI (descriptions show up there)Acceptance Criteria
Approach
Add input descriptions for all of the workflows in this repo.
For longer notes, wrap like this:
shared-workflows/.github/workflows/conda-python-build.yaml
Lines 34 to 37 in c802825
Add descriptions at the callsites for these workflows across RAPIDS as well, for example:
https://github.com/rapidsai/cudf/blob/3e357c708d462b1df93b55a963d9e04973455da3/.github/workflows/build.yaml#L9-L22
Notes
Inspired by a recent discussion with @jakirkham , where we observed it requiring a couple of failed attempts to figure out the correct values to supply when manually re-triggering nightly test jobs.