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.post118.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e6719f49356c84093205f39174f57cb8d4112dcc382e9173efb48b5e45d58f0 |
|
MD5 | 18976b7bf7de715e14c75510d4541d0a |
|
BLAKE2b-256 | c3b1fbf42116785aa5196f9453a6a6f770cdade4cf73c6bd01110ba50980a183 |
Hashes for actions_includes-0.0.post118-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9f47ac071e53e7afd41816f2b8ce3d0937e0f030a3accc71c3bf01dd72207d3 |
|
MD5 | e927402bc3d7ca6d5e6d0091db2f6c07 |
|
BLAKE2b-256 | a1bbfa50e33abc72d2002404f4202316dbca31640a7c30ce76b3c869460662d6 |
Hashes for actions_includes-0.0.post118-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30bad4ab1a88b8022865e23a0308e88edd233e3f4e8ef4f50bef2a080391fbe2 |
|
MD5 | 79c97bb9caab973caf5bf4d6b28ff088 |
|
BLAKE2b-256 | dd9d9f528a84d1328ac884f00364423e4a3590b1606c5b2cdcd1d6d5591ed462 |
Hashes for actions_includes-0.0.post118-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ca5825ee027125524858bc3c5738528258b882fcd5518314e2d7c8e45ddab52 |
|
MD5 | 3e4dd328b1ca5370d2f0f1c31fb16dd0 |
|
BLAKE2b-256 | 1e399071bf15d8f98c1b53de0b06afc110eeebe349fd76bc44c3d060dbfbf0a7 |