-
Notifications
You must be signed in to change notification settings - Fork 22
Closed
rapidsai/rapids-cli
#97Description
Description
The custom-job
reusable workflow accepts an input with commands to run (by convention, usually just passed a path to a script)
shared-workflows/.github/workflows/custom-job.yaml
Lines 25 to 27 in 18279ec
run_script: | |
required: true | |
type: string |
shared-workflows/.github/workflows/custom-job.yaml
Lines 96 to 97 in 18279ec
- name: Run script | |
run: ${{ inputs.run_script }} |
That input is called run_script
there. In all other workflows in this repo, inputs with the same purpose are called script
.
For example:
shared-workflows/.github/workflows/wheels-test.yaml
Lines 24 to 26 in 18279ec
script: | |
type: string | |
default: "ci/test_wheel.sh" |
Those inputs mean the same things, so should have the same name.
Benefits of this work
- reduces friction in updating GitHub Actions configurations
- reduces surprises in
- makes it a little easier for automation to work with GitHub Actions configs (e.g. search, mass-replacement with
sed
)
Acceptance Criteria
- any inputs to
custom-job.yaml
which have the same meaning as in other workflows use the same names (e.g.script
, notrun_script
) - no project's CI is broken by these changes
Approach
- merge a PR here which adds new optional input
{new_name}
and preserves{old_name}
- migrate any repos using
{old_name}
to{new_name}
- use a search similar to https://github.com/search?q=%22rapidsai%2Fshared-workflows%2F.github%2Fworkflows%2Fcustom-job.yaml%40branch-25.06%22+AND+NOT+is%3Aarchived&type=code&p=3 to find all of the affected repos (which might exist in other organizations besides
rapidsai
, likeNVIDIA
ornv-morpheus
)
- use a search similar to https://github.com/search?q=%22rapidsai%2Fshared-workflows%2F.github%2Fworkflows%2Fcustom-job.yaml%40branch-25.06%22+AND+NOT+is%3Aarchived&type=code&p=3 to find all of the affected repos (which might exist in other organizations besides
- once all those changes are merged, remove
{old_name}
here
Repos to update:
-
cucim
(use 'rapids-init-pip' in wheel CI, other CI changes cucim#881) -
cudf
(use 'rapids-init-pip' in wheel CI, other CI changes cudf#18902) -
cugraph
(use 'rapids-init-pip' in wheel CI, other CI changes cugraph#5089) -
cugraph-docs
(switch from 'run_script' to 'script' in GitHub Actions workflows cugraph-docs#121) -
cugraph-gnn
(use 'rapids-init-pip' in wheel CI, other CI changes cugraph-gnn#212) -
cuml
(use 'rapids-init-pip' in wheel CI, other CI changes cuml#6779) -
cuopt
(https://github.com/rapidsai/cuopt/pull/2503) -
cuvs
(use 'rapids-init-pip' in wheel CI, other CI changes cuvs#917) -
cuxfilter
(use 'rapids-init-pip' in wheel CI, other CI changes cuxfilter#690) -
dask-cuda
(use 'rapids-init-pip' in wheel CI, other CI changes dask-cuda#1496) -
kvikio
(use 'rapids-init-pip' in wheel CI, other CI changes kvikio#725) -
raft
(use 'rapids-init-pip' in wheel CI, other CI changes raft#2677) -
rapids-cli
(switch from 'run_script' to 'script' in GitHub Actions workflows rapids-cli#97) -
rapids-cmake
(explicitly provide 'script' to CI workflows rapids-cmake#849) -
rapids-logger
(use 'rapids-init-pip' in wheel CI, other CI change rapids-logger#39) -
rapidsmpf
(switch from 'run_script' to 'script' in GitHub Actions workflows rapidsmpf#293) -
rmm
(use 'rapids-init-pip' in wheel CI, other CI changes rmm#1926) -
ucxx
(use 'rapids-init-pip' in wheel CI, other CI changes ucxx#421)
And then:
- remove
run_script:
input fromcustom-job
workflow (remove 'run_script' input from custom-job #363)
Notes
N/A
Metadata
Metadata
Assignees
Labels
No labels