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.post73.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8df6d0337224943d6025b3658459c2a27a89f31a7df882e9fe5440e2da90deb1 |
|
MD5 | 40819240766facd1df77fe5f3624bd73 |
|
BLAKE2b-256 | 64712771ec003ad96b1d73fe36cfa096b6cf49cb168110268aace5c4e42f18a8 |
Hashes for actions_includes-0.0.post73-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 12d90bcc089c92e3db44aa805186f79e6321bab44d9d888ef56f89f5e6977980 |
|
MD5 | 8397cb8a7d9910c6c5c26e7745fe1c9e |
|
BLAKE2b-256 | 871759ef9e09e83cd6f735c8c2354fa5ac284f9083d0e3f4c9978c83dd61a218 |
Hashes for actions_includes-0.0.post73-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a2942173e239834010315bada36de0d933f6be4d8516b0ecfbca8997fa7475d |
|
MD5 | 5ff88f3b65a77ce39a843bfc6d5ab037 |
|
BLAKE2b-256 | d59c07a3bc559558c3882430efb18ec14e4a00f9b8f6f3c2e0c03eca6bf8415c |
Hashes for actions_includes-0.0.post73-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 71e21b53b352e7445818953d9389e815d91251e0c626327522339857088e096b |
|
MD5 | 06f04dae318a79329def85cb5afc8661 |
|
BLAKE2b-256 | 4d0aca63fb43913bb0d97987c16aa75283e7754e7918dd17e96ed2589073032e |