pyTooling/Actions
1
0
Fork 0
mirror of https://github.com/pyTooling/Actions.git synced 2026-02-12 02:56:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

rename reusable workflow 'Params' to 'Parameters'

Browse Source
This commit is contained in:
umarcor
2021-12-07 04:50:34 +01:00
parent 00105dd491
commit 0699b9f9e7
3 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -53,7 +53,7 @@ In dispatchable Workflows, the object is `${{ github.event.inputs }}`, while cal
As a result, in order to make a reusable workflow dispatchable, a wrapper workflow is required.
See, for instance, [hdl/containers: .github/workflows/common.yml](https://github.com/hdl/containers/blob/main/.github/workflows/common.yml) and [hdl/containers: .github/workflows/dispatch.yml](https://github.com/hdl/containers/blob/main/.github/workflows/dispatch.yml).
Alternatively, a normalisation job might be used, similar to the `Params` in this repo.
Alternatively, a normalisation job might be used, similar to the `Parameters` in this repo.
### Call hierarchy
@@ -86,7 +86,7 @@ Optionally, coverage and static type check reports can be gathered.
As shown in the screenshot above, the expected order is:
- Global:
- [Params](.github/workflows/Params.yml): a workaround for the limitations to handle global variables in
- [Parameters](.github/workflows/Parameters.yml): a workaround for the limitations to handle global variables in
GitHub Actions workflows (see [actions/runner#480](https://github.com/actions/runner/issues/480)).
It generates outputs with artifact names and job matrices to be used in other jobs.
- Code testing/analysis:
@@ -139,7 +139,7 @@ As shown in the screenshot above, the expected order is:
Python package/tool developers can copy it into their repos, in order to use al the reusable workflows straightaway.
Minimal required modifications are the following:
- Set the `name` input of job `Params`.
- Set the `name` input of job `Parameters`.
- Specify the `commands` input of job `StaticTypeCheck`.
Find further usage cases in the following list of projects: