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.post119.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e861382afc7cbe0786e137b4d399ecd49db1bfbd85eceaa956dd587b8965ba3 |
|
MD5 | 9472a1137f6c05655a02d72390489707 |
|
BLAKE2b-256 | 592a470e4d358d876f018d70cf13346ad6949d8bcbede2836b15d5dc06992072 |
Hashes for actions_includes-0.0.post119-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c2cdfe93377459a9069d642d149bbfc4ece0a219754f9c9c61dd46908f4fda4 |
|
MD5 | ce82289416f409639f942e44cf5a5bac |
|
BLAKE2b-256 | 7a4360f4d0caf2bd9c32f745391b52f26f2c303e8b9cc863cc87110adea89d86 |
Hashes for actions_includes-0.0.post119-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | aac4dcf10ea5df88b653c4013d04f7ee7be06220ee86bbbebac15fa1c7e0ef74 |
|
MD5 | 7e8236a87d6ace24eb4f99d55fc85aec |
|
BLAKE2b-256 | e495a4e2799ca9f22a682deb2e6426475374e18bb3e18f07aa355d6eaaaf1294 |
Hashes for actions_includes-0.0.post119-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63025801cc1d9f0323034acecd2419d256710d39a6a2dbca4912a33ae7a41383 |
|
MD5 | a6b2838feaee297118a474589caabd69 |
|
BLAKE2b-256 | 1be05e0b44fce0dc498ad19508908c1bd8939127ae506fa5a3d06fc130bd9cfa |