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.post32.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1f9018d41516499063eaf32291c1343980281d8f20da713c76108eb35f50876 |
|
MD5 | 16caea913f912dcba1d0b4941ebb5de6 |
|
BLAKE2b-256 | 99bc0cfca835b8416ee0a1d52aa424ef7cd9b22b05bc9f0595a3de5621f702a6 |
Hashes for actions_includes-0.0.post32-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4cd49498c881cf2a4bee6be54524a363f10996ab304dab97af093ab2086f0af8 |
|
MD5 | 1ff059dfd2b1883446ac8a4d9aa8b897 |
|
BLAKE2b-256 | c84d2cdb1740006d18e375a7c9e9eb8f0a031fc5a33d50cb8f98451ca7cb6ff5 |
Hashes for actions_includes-0.0.post32-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | f08db7d852f75a7fc62f7c53fb303d036033e176ddc1eaca2c87e9f7885add35 |
|
MD5 | 5c4457eb12ecb33c42183a302964fd2e |
|
BLAKE2b-256 | 5dcd8cda46e15973d1cb396e61d5bf8c53d0e08a9da031f03c093e9100edb1fb |
Hashes for actions_includes-0.0.post32-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc70bc44d6296e83f44ad88dbbfe86172c8ec5e6332adda38dfc4e7ba8ad97ad |
|
MD5 | 030166f2f860ec5185819abf0d06e7d3 |
|
BLAKE2b-256 | f303e87d8d394332381b8a0cd11c8586205acbc20033a55701e3ac8ce99d74bf |