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.post31.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 803ca6d224aa913bc292ae613049ea1cf0dd127e8d70048fea01e91b3e16bf05 |
|
MD5 | bcb45798079ab72f2c406a27000d418d |
|
BLAKE2b-256 | 051630fa0d23383b44a77ec5440ba7572903223d7f8c9759a7f75896f5aeaeef |
Hashes for actions_includes-0.0.post31-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | d2b5e7c39601f56a60d796dd93bb62b9b477f3a52713160e313000ff38f72808 |
|
MD5 | ecde0d9a097ebefe938f7872853d1143 |
|
BLAKE2b-256 | b601eceae09121a75353ffe22f9abfd55f10a1ec565b93668c1af3ef917c5f52 |
Hashes for actions_includes-0.0.post31-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | e93d7e421ac8d8f924c979f3ea55185bd436a6eccb545064e4c19e4212f24078 |
|
MD5 | 38d2b61e13dae3089fb987bbaf37bcba |
|
BLAKE2b-256 | 78f04ddf6f193efad338385736c1d718cf2acca47bf1525118dd42bf7efc1aaa |
Hashes for actions_includes-0.0.post31-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3aae17cebb366aa4a3d0f4394df1fc5ff018718ca2f6e272790b4ba8ccb3839c |
|
MD5 | 0f6e7cb1703a7b6c9ac89ce5bc7c83f5 |
|
BLAKE2b-256 | fbaf3ed31c91e1b85cb64e2847e7ee451f032eebc42d8a4cc984006ae1873378 |