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.post36.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45eabcb0ead39ae4113f471a7813cb654aa728d583ce980eedf338a41a1bfc24 |
|
MD5 | 4926d44b4413166dcde1c90a5b7de1ef |
|
BLAKE2b-256 | 2516aaa44d9820546429ef90aa5d02d8c1212ea90ce6bf5eb34ecd2e7e36d1ef |
Hashes for actions_includes-0.0.post36-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 013cf27b7aaa730df7729902152729b4b8db28cc23731e7f7bd566fa8d713f73 |
|
MD5 | c988cba6fb605ef6360a8509c3ae3524 |
|
BLAKE2b-256 | 85f8d3d826c02531a7e5ba3c2dd7424f941f429a8d10335f38d2db9a38710e18 |
Hashes for actions_includes-0.0.post36-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 66a1fe7202edd5525dbc9cb69cb68225ab159d84cc68997498d888fa8eb29af2 |
|
MD5 | 0cef0f470112c4dbc00f591cc3589b28 |
|
BLAKE2b-256 | b00b03cced1ab25b8a0182c0807baa0e4c1270a536d472fe9839bce86d91168b |
Hashes for actions_includes-0.0.post36-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 71567f982b02faaff9c1ef1ef3aaa59c6f9590d9b0a573b793c7009c1d34692f |
|
MD5 | 705fdcdeab647d82254501dc64875ee0 |
|
BLAKE2b-256 | 751618b0706e9fc551bae66973b05db5bd1f338a65b5228df9d7f23e5b1e7582 |