Skip to content

custom-job: rename input run_script to script #337

@jameslamb

Description

@jameslamb

Description

The custom-job reusable workflow accepts an input with commands to run (by convention, usually just passed a path to a script)

run_script:
required: true
type: string

- 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:

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, not run_script)
  • no project's CI is broken by these changes

Approach

Repos to update:

And then:

Notes

N/A

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions