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.post43.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84da44fb9ce490345461615b0d24c5ad72ad4a2f1c44c30f972839d2133f8953 |
|
MD5 | 614677a7cff1955c28050a602ad63407 |
|
BLAKE2b-256 | c7ea345e5a89f685954e761a62fe6dca2761680c75eb6eb8aae15676654aeeec |
Hashes for actions_includes-0.0.post43-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40eed6ed06e86f4f60220dc9c64e21ecc54affe35c69f8ed25b90bdad31189b9 |
|
MD5 | 96e6a611cc73c713e9ec2045377cf824 |
|
BLAKE2b-256 | 91b13955a54e4ca0ff45808990256ffacfef87b575071d1cb252fe6a678e09e2 |
Hashes for actions_includes-0.0.post43-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9041c05fd98c8b9ee5f3858aaa1fb9182a3c1abcb110b415391a61bc409dec79 |
|
MD5 | b72a56150db1084070ecc135f86af3ad |
|
BLAKE2b-256 | d7bfc03e085070b0c51f69698c4aa36592e4f4a823fc559e1667dc68483ebd79 |
Hashes for actions_includes-0.0.post43-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aed6ee5da007fbc55d47858933de72b1423cecd31f21c9a5b605f936883357da |
|
MD5 | c49233700bb30969718c40ef74b5b624 |
|
BLAKE2b-256 | b60ed73ab08a45bfe42b2665be46c6815ee45cd78421feb4cb87fd8481fdeae2 |