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.post54.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 281e4c1807ec56ecb12dcfc585655d1ab613608c2c1cd6311969121d066677e6 |
|
MD5 | 11cfff70ee5bdf82ab9a93ed924ef8dd |
|
BLAKE2b-256 | 22a363117c6be704ef7864d13159aeb56e0db7ece4adca51043ae7807f648980 |
Hashes for actions_includes-0.0.post54-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | b12418584a52d1385096d3f7bab7c9aaa8a05f89861d5d3722b0981727b2753d |
|
MD5 | 6404cac74ebe86f9a8e847d4ce5eedc0 |
|
BLAKE2b-256 | 0a1b36a0f92f6b3a5418314ef058fc7e098a7fac39b6a5e802c7c6553a570745 |
Hashes for actions_includes-0.0.post54-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | d9d481a4311970500fca19184fdd39b822a4a210b44a2015c80927a8e73ad518 |
|
MD5 | 9ec9257a91ff23db49bbcacc69b0b24a |
|
BLAKE2b-256 | 844be4a6096153ae532a38c41c5f00d495040af469526529d2b02effe97d1e02 |
Hashes for actions_includes-0.0.post54-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc5b01c28bdbae1e3227f9a1417e7d279d10efd70a32c8330f77067ccc13e2af |
|
MD5 | fa902a8d9e44069b91975ebc7cc70a4d |
|
BLAKE2b-256 | da8403ca158e11522d73a807337aafd7e58917838e5a28234fc9a4f3b74eb67c |