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
The shell
parameter is deduced from the file extension, but it is possible to
use a custom shell by setting the shell
parameter manually.
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.post117.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf0960dfbc511025faeac9338a1d74d0155abd3858aa6b7482e3bb9fc0af16d3 |
|
MD5 | dbd68dd7d33ebe697e16b977ae330fdf |
|
BLAKE2b-256 | 9fec3ebcc305530a2368ef0d6b13213cfb20b2835eaf13e5acba7f163aa7d5a8 |
Hashes for actions_includes-0.0.post117-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 519785d3852577ea5d8dd051529e36518970076402b4ba5b2fe17b0378701b6d |
|
MD5 | 6ba457dd65469cc9ab5554080eafe32b |
|
BLAKE2b-256 | aa3ca4babdb4cb49437633e8e732b0215a3a709ca5cc18690bc9914289c0d507 |
Hashes for actions_includes-0.0.post117-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e06fc397f0c17fca14d8f9e127f07ff17ab5cb7c82eb81846cf9b061803ee3a |
|
MD5 | 1f3fd6110683bc71b20ca5d673aa00a9 |
|
BLAKE2b-256 | 97adb7c16aeae18fd5af761737b49a99af6302b0f58f061a52285a6cd73dcc5e |
Hashes for actions_includes-0.0.post117-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c10e3202181e1813e743da89bac78c0114808cc03f95f69e177e82cdf4ed3d67 |
|
MD5 | fa57e6a393994057def6de48a4435108 |
|
BLAKE2b-256 | 5ce93e632b915259e4afb3562be451c8cc13c7be616a472dc73bb141e4b53177 |