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.post35.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c95fc8ae648482a2aeafac0b494db83b2c2ba11eed205c84343f2a9658f61c7 |
|
MD5 | 3024c3eb9b52c58621e716d001e70184 |
|
BLAKE2b-256 | 3c1e21794137713f8eb8c8fcb510bb5db7d63aeab22c0302a8b7d1af1b52fab6 |
Hashes for actions_includes-0.0.post35-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3fbe6aeb291feecff908d301352c59c8661cbbd4ff1008baedcb1d9d11896d2a |
|
MD5 | 85b1b28c1f7144d97d4fcf6b8912096c |
|
BLAKE2b-256 | 73c0256089511a7032d56c82951162eb53632130655217b849d5edacf642ec35 |
Hashes for actions_includes-0.0.post35-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc9403f449b798e68df694e46cafc6a1a3f6669dca830cdad3936ff363058088 |
|
MD5 | 70cdf9d1ce0d381bf70089b23437ba7b |
|
BLAKE2b-256 | 7e64d7a360a1583cb8eed93499095b52d1d07c3feeb679d675296ee2e23c78b1 |
Hashes for actions_includes-0.0.post35-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3344edb15de7674ca9e57579e3d8b86bd4333049f91372cded0eb68bf12095c9 |
|
MD5 | 6e7fe779832e145c3910eba3e26dc7ef |
|
BLAKE2b-256 | 0013a4c50e2849da825896b33ae05b479dc7b5d83b105330eecc2f1e6826f550 |