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.post99.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d9b434ea1625b9fb40791dd51a42b6b30a1bbdd294941013e3098c0b6709feb |
|
MD5 | 27b12fab01b2f1bd3591020727c221af |
|
BLAKE2b-256 | ef42ac96c25b9b9a4ed84ed2c54c1e3d3443acfdbb2997efb29dfca36dfafc27 |
Hashes for actions_includes-0.0.post99-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 47281a40c1390489f815eeaac814cbff23a83d2f5e58a964da4af901d0ef7f9c |
|
MD5 | f4b732b2279508f7c6ee48abc2d5f477 |
|
BLAKE2b-256 | 6158f34d0fe7c2440c3b77ceedc3ed2ea69c45df42f1f123dfb8a9dd0043f1ab |
Hashes for actions_includes-0.0.post99-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9456d36bab73f1c399f9408b68c5b559c43919bd32dc7780ed80a7833de893f9 |
|
MD5 | ff4cab6aacbbadb60cf7a427b508d33a |
|
BLAKE2b-256 | 5abb800521620db06c8f0f5165a9b1773f1c7a93d6a84c356b51e1fe2b122066 |
Hashes for actions_includes-0.0.post99-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7abfecd302940df096fb5a94f2d68f3d39c82d7ae1685df458a7a5b13fd9a1f5 |
|
MD5 | 4de669c3abf9a11e44314c6866bda92d |
|
BLAKE2b-256 | a82120a0e7cd6849a5e587dd8516e790797695b7d69c213397bce4acab0bb090 |