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.post47.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 66edc583f1011d2a80e2cf4f7cd0491ef96bb31172c399a18d355b2f66b2ff39 |
|
MD5 | 267f561d0ec92249ef36e295671c6be8 |
|
BLAKE2b-256 | cd623f760bdb7cb9473816cd5caf340e24183a87b6cd8cf9d0edddad7bd52e76 |
Hashes for actions_includes-0.0.post47-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7bb164bb4d3b3e965c78f6c5d44767b88e5c5e0c5f23f7e3aeab89a44f2acff6 |
|
MD5 | 456f9e5ece205528188937691b379c7d |
|
BLAKE2b-256 | a0bfa30695cbf848363e6261db206ba251d3632d903811e9ae8e6a8efbab9fd0 |
Hashes for actions_includes-0.0.post47-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7dd7fa723e7c2751a93d7690d4f081038bd8b068529ab5a5edcaf42a80714235 |
|
MD5 | 54db194625f83e311dd545a79e491dc0 |
|
BLAKE2b-256 | b096480c2bcb5e853b41da462c98f29beffdbbb1a20075e930f0e53e9f3d151d |
Hashes for actions_includes-0.0.post47-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 980ff47ac8204cb73b2e919cbcab14d3e70735f08a5c29d23b3b7c91a47fcb9b |
|
MD5 | 56dc2eae2535333374a6694f712119b3 |
|
BLAKE2b-256 | f7b930a6e87656a0d78ee1bcc40ef91811e8d375dfafd1f0711971e12ad2437c |