Tool for flattening include statements in GitHub actions workflow.yml files.
Project description
actions-includes
Allows including an action inside another action (by preprocessing the Yaml file).
Instead of using uses
or run
in your action step, use the keyword includes
.
Once you are using the includes
argument, the workflows can be expanded using
the tool like follows;
# python -m actions_include <input-workflow-with-includes> <output-workflow-flattened>
python -m actions_includes ./.github/workflows-src/workflow-a.yml ./.github/workflows/workflow-a.yml
steps:
- name: Other step
run: |
command
- includes: {action-name}
with:
{inputs}
- name: Other step
run: |
command
The {action-name}
follows the same syntax as the standard GitHub action
uses
and the action referenced should look exactly like a
GitHub "composite action"
except runs.using
should be includes
.
For example;
{owner}/{repo}@{ref}
- Public action ingithub.com/{owner}/{repo}
{owner}/{repo}/{path}@{ref}
- Public action under{path}
ingithub.com/{owner}/{repo}
../{path}
- Local action under local{path}, IE
./.github/actions/my-action`.
As it only makes sense to reference composite actions, the docker://
form isn't supported.
As you frequently want to include local actions, actions-includes
extends the
{action-name}
syntax to also support;
/{name}
- Local action under./.github/actions/{name}
.
This is how composite actions should have worked.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for actions-includes-0.0.post27.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ffbcc6a8977d97f0ce0fc95d1154d2b6a198475f232bdf4dba6861f6737db0e3 |
|
MD5 | 3fb9933156ec73f6e9be9090a83a6648 |
|
BLAKE2b-256 | 6bb291503cd722a1d4343529434cd227bb964a32e5cbf04607b9ee2c075a8c0e |
Hashes for actions_includes-0.0.post27-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f4d853cdc9100756da49d44f1343649cb6ded4840cd9e8a4299a00bcc8fa7f6 |
|
MD5 | 6fb14f9630e30a2702b7b09d26d5776e |
|
BLAKE2b-256 | d400cb154fc5618125584be49d77889843c38ee5af3de21d6481c6e30a3b7f98 |
Hashes for actions_includes-0.0.post27-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ee721edce8c05e3cd36c956d4db378b4c1bbb9dd7050b2775a94992c9aea1fe |
|
MD5 | 89069c43c1d356ead1f8d9a7a9f3c4f8 |
|
BLAKE2b-256 | b1761da59471c49a82bff1438f283437db042f0ccb042db1683d5eafb94bd13b |
Hashes for actions_includes-0.0.post27-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17be838eb5d604b0e2cbcc3b7f905f0a37be13f32994999574f0096e9187941e |
|
MD5 | 607d21b6a5bb4a850d376365df49eb1d |
|
BLAKE2b-256 | d880469f2645ccfa15ffdfcb49813cb1c614fe34d1db854b0730cd28603ddcaa |