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 Distribution
Hashes for actions-includes-0.0.post26.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9663d3e397c12650d77eeebdd8663322ff36eb2ff11014da63de9d10231cd17a |
|
MD5 | b3fac84695dc00c66b73183028384c19 |
|
BLAKE2b-256 | 1f99561c281eefa788bfff3a6a193bb1e3451bcb670a13630aef672d500811f3 |
Hashes for actions_includes-0.0.post26-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29b556e6a477561fc7797c13b4178664ecc81062f5e3982d16ca2dfa0cc2cf85 |
|
MD5 | db54dea6db880ababd941676253116ec |
|
BLAKE2b-256 | aae7e0fbe457ddf44a8c600175a9df273421e9d0ef8b687f474bf97078c80bcc |