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.post100.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0f390aa6f3fba60fefe74adc8641634dfff7d655c75d80aa003e82ec0e98b97 |
|
MD5 | b2ec29f28f5958eddaf5afbcd409b6c2 |
|
BLAKE2b-256 | eccb2ad63b050caa85e96b43b185d31f39d871471d2c66f0399b9568ad9ac6a2 |
Hashes for actions_includes-0.0.post100-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86e7a494cce047305bc4d39115d6cb378deb10dcfcce57288763d9f4ce8ddeef |
|
MD5 | 95964ef4ea823f92aabb5132c16741e8 |
|
BLAKE2b-256 | 8c524898cc52b6e2863c97d3df86f04a384bd355eee65a15bbee645609c426f9 |
Hashes for actions_includes-0.0.post100-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2bc546ee6e27eb6d5af7cafa0b28b60b10d13b50544fc41eeef8683e7cf54f0b |
|
MD5 | a644b897aac3e98144fcff04e309ae9f |
|
BLAKE2b-256 | 7cb1c82a64474cb16a09a68ae85f2461c7ea44ec1f0b1fd8c0daf4c994803210 |
Hashes for actions_includes-0.0.post100-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57a6157faa32cfbe7ed47dc0840a6a2bd9b8d11cebc2006383994b48c6dd0527 |
|
MD5 | 0adbef6c55c86c94c64e3ec12ef67d7a |
|
BLAKE2b-256 | 8aa12a2990546e268c592872bd7450ad83168116ea22da34718ba12b0880a2f5 |