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.post71.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d300005ebbc7dd672054fb7916ef0d920333edacf5ed9378033d89f25e3a10db |
|
MD5 | 108ebf879c3e3691aec15bb35e6f85f4 |
|
BLAKE2b-256 | e7105599c7a4f9c3f85fb3de6e379fa9c2460b53b0501b2f8672df58baa84adb |
Hashes for actions_includes-0.0.post71-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | d814e377fb1bec9b9df274d1b7f1431c5e9dd759b105769637880be527c30347 |
|
MD5 | e63672cc7ce4c36bff2dd2f0df42a64b |
|
BLAKE2b-256 | 253ce5b521e7db1d61dfb607b3f05426207d34c06efc340a00ed9af32b9654ad |
Hashes for actions_includes-0.0.post71-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f8b248b9ee8dcb89313ced3a521b3796b9ef8c07dacdad46947c3e8f431458d |
|
MD5 | 98feb8004593dfc440d8ce465b2d5c42 |
|
BLAKE2b-256 | 8e70f9e0efd6975de91e50608c1b5166d47ebfd2aad73b24170706decb93574c |
Hashes for actions_includes-0.0.post71-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1965d17266687b862a8b5abf77b07264607634eb73aead8ca7f360e25d2f0f42 |
|
MD5 | c4dd29b96f4b440c5015eb7bc4e2a307 |
|
BLAKE2b-256 | 8149f5b9bf49e29b92f93d3fb4f408f9f92578ed6ef51a3c969bc31482446802 |