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.post39.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d37aad83a4775a348b6d47dd080a3deb7cadc6716b3d7dbcb421463ec5f2c537 |
|
MD5 | e1cd023b7cd27ce27d47fc1a98c48492 |
|
BLAKE2b-256 | 1420ad0858d34d865f35f45b09b42149edc18913821a53d4ac8f50f941d4a521 |
Hashes for actions_includes-0.0.post39-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51289d32b06f0abfe40d556929cd4bf2b24b17260243280df04a586ea91c2ebe |
|
MD5 | 7f850fe2ba463d562b5e4b0ac9198780 |
|
BLAKE2b-256 | 684a5f750dc3639c69f8ab7a10d63c4414c5f33ae8018fbcd1bc4ce0fdb15acc |
Hashes for actions_includes-0.0.post39-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87f00057217950c3a78c425a18568a92e85df1296983894893b12bd8bac32f15 |
|
MD5 | 37445f66d9bdd61775e725aa205da4e0 |
|
BLAKE2b-256 | a6b13b9470c77e41da2f84ac5fbe3dfd20d8454738de7c011f2801a3c4febc95 |
Hashes for actions_includes-0.0.post39-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5214dc25bdfe23a69358774c16a377d4d8763601eac9cb6170ae64240232941e |
|
MD5 | 16654bfd41388e4cd05e7db99ac64755 |
|
BLAKE2b-256 | 0640985eb02be0f3ed23c3780d09fa0637d70d22b6667a24eb840883e2cb39f6 |