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.post45.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b67091b158b45165a5087cc77cbbd64caf13bab01965e6f6a0ef96f72eb93f4 |
|
MD5 | 6af6fb9355a0ded5d8febf666f68f9de |
|
BLAKE2b-256 | 2ec51e6853d57b900da5b64084d69f5fee7583206c9056870b9a522390ac9af0 |
Hashes for actions_includes-0.0.post45-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 835beb13d6b119769be76b213ca12dbbdbc621f2c2aca7e051b5f32091e7b654 |
|
MD5 | a6ca06a3cc7aec8be72e849293779b44 |
|
BLAKE2b-256 | dd702e1c1c41e274593c39e3d0d4e2ed04b52ace496cafe04ad251e20916b581 |
Hashes for actions_includes-0.0.post45-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 257ce1a5742aaca1a858d7ec5d77db8b0f9f649d75bb239d88d05d7b4d3d73f0 |
|
MD5 | 69a619ddd680e3d1fd7e520a7edcf2e8 |
|
BLAKE2b-256 | 900fbd9e7b28e35e420c42027dad4c1bc3105b249abbf329a50063c0db459006 |
Hashes for actions_includes-0.0.post45-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 246648d269a71163772c7332131549aa0a45a44375304dabef5d2cda1d94be15 |
|
MD5 | 76c9dbbccc509c851eb35a6e8a971062 |
|
BLAKE2b-256 | 368808bee3f5826e9ee175204797df80a7de0594c617c8116e9c5fc5e095fba7 |