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.post105.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65f38c2bd5965caf8723828e7a030c90736a0cea722fe27e4154a55afeb1c90e |
|
MD5 | 2eddf802b3ad88d8846b1c5f793820ab |
|
BLAKE2b-256 | 94786f2824c6d2c5aacffcf2391e56950c03ee7917aecfe3d5109ace839381a3 |
Hashes for actions_includes-0.0.post105-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7209e82a57855e4808ad8d441cce6ecce1ff5d8aea56adea5e418d1fbfb4e080 |
|
MD5 | f7b8977c456eae005bf9ec2c9a5f137a |
|
BLAKE2b-256 | 49c36baa04245a70ff47f0d599f0c5c03f77d4ded99f1cad39f02ec739998b4c |
Hashes for actions_includes-0.0.post105-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1bffa25079776033590909e14c8b44e7451edd7933c9519730749dbbec10449b |
|
MD5 | 9d5d4b4f367131e2343589a60a3e7919 |
|
BLAKE2b-256 | 2fbd5c9659b277fb2ab5eae4210a0b0e27d12eb33efe93ed230bcd9519250454 |
Hashes for actions_includes-0.0.post105-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1de5b3d58cafd8373034a3803b7e42a459260090a918905321d059f40f5dac8 |
|
MD5 | 986588fba2f1d4d1e5a00a674e42e462 |
|
BLAKE2b-256 | e8f850b574d6efb09ba49e7c580c83af4e9593e288146e6209f86409d5f4960c |