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.post59.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c220ce968b2660b43ae33cd411b08e2acec95b32e3a978d7c7c135af6b1223f |
|
MD5 | 68c471780464114bc251c4096caa8022 |
|
BLAKE2b-256 | 0b2313fafc1bd97eb94ddad33a15660be62fbc45c34be1ac65ef0a86d40f5b19 |
Hashes for actions_includes-0.0.post59-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8a6e5a8243a034b2364d49aa634e4f533f96bcd94f2c1a0001318044cec5c32 |
|
MD5 | d28a385b5315a3214a278c26a30407dd |
|
BLAKE2b-256 | 43e003326c44a7053eb74926786b1ac81abf0d6d2ea876f1082fbfe8931236d9 |
Hashes for actions_includes-0.0.post59-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb5987efc8d60b0604cf12afa4a92a2742f7e1fa34bf3da1aee59d16e86a33b0 |
|
MD5 | a24f577e63e6b8a874d1c83542e24e74 |
|
BLAKE2b-256 | fa1fccaf64d65feebd4acb0f20d0a4d6446baa26ce1409b0222fd7f8e2826819 |
Hashes for actions_includes-0.0.post59-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3315299dec6c2c39104e4208381cce657d7656355ac2257243abd1193730041c |
|
MD5 | 0cf57ed354ec9608dcabf6b051c07142 |
|
BLAKE2b-256 | ba26923691b61042bea69bbc0a43d385dae83684482b437500cdc48b7f086635 |