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.post58.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8288c3292602ff4738a5f284f68abdcc9fadaf4e0ece641898c29c6f3c694bb4 |
|
MD5 | 996094d3f556d8fe64830c986d476d11 |
|
BLAKE2b-256 | f37a58df14abfc2c4ba07ee677713c34df145c26fef885c640f95ed01743d366 |
Hashes for actions_includes-0.0.post58-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3dffbc1723e4f7e8fa1fd730af7154eeb6cccd9205231bc8fd90984375644d5a |
|
MD5 | f732ef7fb992aa0ba4528a30248d5209 |
|
BLAKE2b-256 | 8919b8ef7f667d51759b77fa881f980ae50c0c695bd3a33718ae91b05f89d0b3 |
Hashes for actions_includes-0.0.post58-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | f42273e2a1510298799a413cb6f6b9663809c4478658a8422de0c60ae15d8f71 |
|
MD5 | 1d0f5f6ddd73bcbf5c781e3aae52069a |
|
BLAKE2b-256 | dd7dcdb941877ac77f4833a4ffab11a96d659a849f52456f58fda6ed23548533 |
Hashes for actions_includes-0.0.post58-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4cfa0ba1528c36cf6af32619b8b8144c901454492ddb23a369bd8bb74b37310 |
|
MD5 | feb6931d585d3700eb663bae66f8f4cb |
|
BLAKE2b-256 | fdef9650c054c0f9628f383d5dbdb457c583d4de68849b0b559354c7c83cbb3f |