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.post106.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f823b148f1e959993f4db526c480d1efea4acb3cc1f8a9294faa53cebbd2a645 |
|
MD5 | 0f4fecf59df5570ed3b69cc794c1f3cf |
|
BLAKE2b-256 | 47afd214f1e1e75cd43b5d064de464b795b30a2dfe9cea210e91b3d008bfebd8 |
Hashes for actions_includes-0.0.post106-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39db95aafd47646378701049a64f9a68e3e87959beb06e809d2035302c8b0bdf |
|
MD5 | 9c2693ef80ec82084bc1f4c1abedc27a |
|
BLAKE2b-256 | 39aa17764542ccb99cd6c3cb1c94b72d16e5fdc1010338e402ab808886a1d48a |
Hashes for actions_includes-0.0.post106-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40547b8fa135069f08879892e232161f84c98f7cf6c3238b0e9456484d656f30 |
|
MD5 | 54b073be1b223821aa97db1799047259 |
|
BLAKE2b-256 | 893624288c3ad872e693dcf02de940275d67d979871e2f78c6e74e4ef353e76e |
Hashes for actions_includes-0.0.post106-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6d469fb98a566dff9b11210d3686239b5d81d661e9b4710c24bf3a15593198f3 |
|
MD5 | 3f2bc3c7a541b152241bd583f28315bd |
|
BLAKE2b-256 | 7c26c1d22e20e49eb96fa9cd08c77579bda582a07f3e2cbca37288091b8fafe9 |