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.post57.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a93fa9be94119aa5d4f6e22a2772875262140bd21e497d992288b9c4e0753845 |
|
MD5 | a8c374f6f550dd0d8f44c9e18ccf491b |
|
BLAKE2b-256 | 86beca44bc644380629079bf46bea1011decd3a27e4228e4cf1480265ded4672 |
Hashes for actions_includes-0.0.post57-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87a8e4b9552ba1861590485988d03bea529dafacc1bb721c94a372b85c03694d |
|
MD5 | ba56b4fa09a462acc4a50cec9447392b |
|
BLAKE2b-256 | 8fa126360ea146c9989e7b2001c902e0147bc5f6eb18bad58237821c4af0a677 |
Hashes for actions_includes-0.0.post57-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | b86da3356f5084020f231bfc25829d1b2568ddef6be0a64778eac1e00635d0df |
|
MD5 | 17f196b0633cf2444614a78cb1f74e1c |
|
BLAKE2b-256 | 67ad90f2d542fec14b13686b6017a19a0cbed0f41e3ae33974b7ff1da9032186 |
Hashes for actions_includes-0.0.post57-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd3252555db135a58f9da2dbd766e6b163fea9bdd483fd6dc456a790805665a3 |
|
MD5 | 19a2c171bc0ea634e2d3da93db3c4ce4 |
|
BLAKE2b-256 | f610bce226d29cf51bb837d0b9c8ce9e8974856f8aa296a62c766ad759b32426 |