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.post42.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa874520d485f610b8f6bad1c03445498a26122a8a52c14747b25bf155341b14 |
|
MD5 | 2c4a56315d275cfbb3478746e789ebef |
|
BLAKE2b-256 | 91afa8d6adb8b47d2a6954f6a635b351ec36a2bb07d5b89f2f0903747eadcba9 |
Hashes for actions_includes-0.0.post42-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 68c2de539cb86acc0b86c6c2e58228f09c4860f7a4f3b0a6586210d9929c8130 |
|
MD5 | 081da59496ae5db39c2070861663da49 |
|
BLAKE2b-256 | 66cb83fdb66873855b995e3210c4e5aafbe99cd0c9398c5d431cb4755c9aaa0d |
Hashes for actions_includes-0.0.post42-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1337613b5250c758671d7f4704f5fc7fe37c2755b480ef2fc7f21130614c4933 |
|
MD5 | 5fecf352202a1a94992c4359fcfc9ffc |
|
BLAKE2b-256 | d39ab97198ad48180dccc96c94925499fbdbe6d9328442b8f051f6f7094d8777 |
Hashes for actions_includes-0.0.post42-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb465e9dd224f1cb01e2cb130c53ca8cae0997bbe72a90346fafbf2c177966fe |
|
MD5 | 0913f42bc4cb0a73273bec49eab71044 |
|
BLAKE2b-256 | b0523e8e0006faa4193a8ddd0aa7691cb41d147016cad50b764061f299e98887 |