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
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.post75.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c31aafad302bdd36e1bbbb2a4183980f5de3cb44d66639d871988ee4b731c36 |
|
MD5 | 810855a5e484531b535e870beec5d9ac |
|
BLAKE2b-256 | 2a91f2d5a0794fdc4630ee7d43b2223463153e1ab1830d4e1f72ef1a25df407b |
Hashes for actions_includes-0.0.post75-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 05004bb4a740afc7e61c71fed3154f8359cfd8c5fd51f13accefb25beb6406ea |
|
MD5 | 7912e541f5491fa7a6a19b7e6ec9bc07 |
|
BLAKE2b-256 | 989d96d7f4fbed1e34829a5e8d334c84800d204ebcec50d8209811621edb06ce |
Hashes for actions_includes-0.0.post75-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 099aface6253cf47760128baf5274c0615f3e5be5fb0965a0510ee7636fbb6db |
|
MD5 | 4071c43f40e1587a76ad23e42f8c1990 |
|
BLAKE2b-256 | e6dcf03e10892bc73e27cffe62736ea4a5ae9a814ee793d54f926b71faaba4c0 |
Hashes for actions_includes-0.0.post75-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0037bc5238addf818551304709f01f7191a91373fb8dd3bdbbf66797ddff59df |
|
MD5 | 1bf2895cf14236d47a209501c8117e25 |
|
BLAKE2b-256 | 1e6b57da545fb7d0425b3af7bd538aad7de58f5063a4671382c0f30fc8b84759 |