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
includes:
step
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.
includes-script:
step
File: script.py
print('Hello world')
File: workflow.yml
steps: - name: Other step run: | command - name: Hello includes-script: script.py - name: Other step run: | command
python -m actions_includes.py workflow.in.yml workflow.out.yml
File: oworkflow.out.yml
steps: - name: Other step run: | command - name: Hello shell: python run: | print('Hello world') - name: Other step run: | command
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.post68.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 80ca5abdca56126e5d6df1263f42f5465e99f7ade3a61b1a6f2980c9dcca0f17 |
|
MD5 | 176bb9a1ff315be68449809c123bc1f7 |
|
BLAKE2b-256 | 5b18806def9dcd1df86ff5b63b1c4348dd0c5f89d693e3c4c37e7f435423b0b3 |
Hashes for actions_includes-0.0.post68-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | f151349d765a92a2d04881e71233b75c1c4812ca33ed572a99ad4236b45987f2 |
|
MD5 | 78949e7e2688dc729d8c85a8f3f39e7b |
|
BLAKE2b-256 | 86461c3d478ce7b4b440498a284aff7175e85e421d723bca08df98b2a2316db8 |
Hashes for actions_includes-0.0.post68-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 519b2035f122b01f18fd51cca5dc6d0a2188a44ac2d033f5ecf5937f5a0cf0f2 |
|
MD5 | 3b1e7180124f38eb7334a1895e60147e |
|
BLAKE2b-256 | 6784c8f2d531e096f084b681c27d679f5890b8b8294a33f705ea75d461520981 |
Hashes for actions_includes-0.0.post68-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da421eeb4fd3e9b7fc9fcb790bda9776f068d4633a5de7d29e9f3984adbe4b34 |
|
MD5 | 5c80ef2bfbfcacdfeedf0ede91e34e5f |
|
BLAKE2b-256 | ba18d490924462aeccde74f855566b5604eae861777c3b12a697bfd5a22efb2d |