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.post37.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89f41545809a29107394b89ec0bd1e4ad97aa4f58750ca4f6144b702aa49c72a |
|
MD5 | e9b4693b9fcdf615a6d1468f353d105e |
|
BLAKE2b-256 | b61d7997a77cb9a9801d3ca92d5a88a355f3c6a6eb8b8d0ab762da0a0089ef5e |
Hashes for actions_includes-0.0.post37-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5585669ff9271a2075a73e1e3b488303644fe63565fed6ae75b7e06fa3163e78 |
|
MD5 | f528cc33626248392ecee1e2dc54b847 |
|
BLAKE2b-256 | b239b56eed2f30f2e53d67607fa450f8da83e97b60098c1d4513570a0178325d |
Hashes for actions_includes-0.0.post37-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25b2125723297df2061229517e0e7291ee2193dea615a25c338690fda4f4918e |
|
MD5 | 5ab1bf91175236d8c8cdaea7eb84ab37 |
|
BLAKE2b-256 | e54469f67b7c01fe5ee1c335fc40a5b3295fb0d5c6ea418450a25861629b6bb1 |
Hashes for actions_includes-0.0.post37-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 22f6e958bed543c3448ce4d1de65ab97257fd8e745de16e71a28f1a2456dd93f |
|
MD5 | 9ddf2787ebb60ee2371613986cb929b6 |
|
BLAKE2b-256 | 42b366a19dacfd577fac0101bd682a6d102d33001e2098b66b36581da2cb463e |