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.post38.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ebb56d5b03b12cd984dc98ed1c483d96ef53f9ae35f5b1c6020f97fef7e7698 |
|
MD5 | 8732db0ddfbc879c8b387da842a861ce |
|
BLAKE2b-256 | 601b615d2a2518cbc78b9924bfdcca4bec311b4fab022b1d57ead76841e6cd92 |
Hashes for actions_includes-0.0.post38-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23d19fc8c3b08ca9af6838f2b9ec382565416bf3584ce450cddd1634f5259d34 |
|
MD5 | 9c1ebb514d3cdef28d21e53e7445a842 |
|
BLAKE2b-256 | e619f8c47cee5e44033c5fbd59aea4f7822763247e77dd0818302dd5406223ee |
Hashes for actions_includes-0.0.post38-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | af7290e0d71532dbaf533eea69a28f860e9276e87a11f494a36db9e021716db1 |
|
MD5 | 60ad5b3569459c0d6f3163e7ba6078c9 |
|
BLAKE2b-256 | 27318a6360737f61543d2740b3fabeb1633ed943c0af1d2746b3cdec94aa3eb0 |
Hashes for actions_includes-0.0.post38-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 211a7e956edf3f0b59776bfcb78448f50bed444125f84d34a45cd368eff2d956 |
|
MD5 | 38ee356d2b157a89af26d31a5d62f752 |
|
BLAKE2b-256 | 02966ddec3b5948b218aeb03a215db3903de07a62c09d998bf31d7fc68146970 |