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.post121.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c8d8f2c43f38334dc0a46f18e164b8b70a1c66205b745563410499be2dcbc36 |
|
MD5 | f55c5b5843295e2cf8a244c35ff22a84 |
|
BLAKE2b-256 | acd46b1e2046d1239e3c18c233f0697580b0837c73a7cc63752107286b6d0f06 |
Hashes for actions_includes-0.0.post121-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 124342256a11f43ff9fcc7b3739b5eec4c2c6b4ff9eb5c946209480521c86566 |
|
MD5 | e5925ae5be0bdc2e52303cc969787282 |
|
BLAKE2b-256 | d2b0bf19018e14814de8660a479c970af535845284968c34746fa4f9781b9ee8 |
Hashes for actions_includes-0.0.post121-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | d14334b132730e1fbada5cb8f9ddf6264799c398141aba464aeb9dc3ab72aea2 |
|
MD5 | 5fe0646ac71859a48e245a928b44e0d5 |
|
BLAKE2b-256 | 215faed876aa0c71fb43817ebabd3ced41eef739e8b602a7ed33e1dfe6cbeeeb |
Hashes for actions_includes-0.0.post121-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 77534993eb70f84f8ca9879f3060fcac1aa8006ecb947985f431ed7952f6b798 |
|
MD5 | dd7f7793304afa3dd9a1d79ed1c5c440 |
|
BLAKE2b-256 | 167d200e168aec6033cbf515310d75e0cb5c5ea7355ff459d02c95ad69833b90 |