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
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.
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.post52.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c6f22f4a30473fd950355a6132002150b1ed8f45e51e734a3b26957ca5fa8037 |
|
MD5 | 39df06d6310e7c3e4a045b05b2e8fd73 |
|
BLAKE2b-256 | f95e702dcd56d5a6fece154317000a478e1c42afcce60c13cdcff62d1d3e5fc8 |
Hashes for actions_includes-0.0.post52-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe8fc36a2b71fbb340c6653c2310570b3adb9883734bb98bc10bb7f154ec424b |
|
MD5 | cdf7d01d804d3547b8c310d407e409d5 |
|
BLAKE2b-256 | b5d75a844a5ed3a5cd630f617c9c893b9679233c993c8545a8a59d7c9443ce12 |
Hashes for actions_includes-0.0.post52-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1b5c01d125c047c9856522adc88a572684c7e46e4a7f15432942e46af7e1be14 |
|
MD5 | 939a6691f7ae39799aedcce962cf8085 |
|
BLAKE2b-256 | c789f1f70841943cede685105cac603eaaa49dfa523ba12dbd58222f5716b6ab |
Hashes for actions_includes-0.0.post52-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b37b6c85b516d99a9d59bbaca0ae7e787308a7c59bcba5902af9e2c970df595 |
|
MD5 | 92ffa80bdc95d67d6149e5f5f3174f4b |
|
BLAKE2b-256 | 79e800318fa3ff17cd8cc1413fa1eb70db7bcec72fa15bb68b881c9ec1519b99 |