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.post40.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ccb3febc41f58187e6e8ba3e556e459b0217c708ee467d7a8ac0a2a3444f4ab6 |
|
MD5 | 029ff8f42860ee741a6f407736089fab |
|
BLAKE2b-256 | 4508302f443c480c9c3f0f85af2d860d78c3dbbe6ac2ad805dc7cbfc16367719 |
Hashes for actions_includes-0.0.post40-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | b5a8c14f0eba703dcf5c6ec2331720a5141b463033681a90448c219214fdb86e |
|
MD5 | 3c217b185f474bf1c5b13efd0af3ab80 |
|
BLAKE2b-256 | 69dccb5060dd77ee84f2e88c30e739853b61f46b03c713f267046ab0d31b0fd7 |
Hashes for actions_includes-0.0.post40-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff2845a09edd237c135a999f16a0d4e645ccaedb9d62db9970c46f22c1c1c003 |
|
MD5 | dd81ac46d483eaeb26dc1546dcfc617a |
|
BLAKE2b-256 | c107c3fc5530413167b443ab99e3c9caf5b2578fd093327cfda3b3d284c5e598 |
Hashes for actions_includes-0.0.post40-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27ca6728b5ac8dc7115e857fd89dfa38a0ac420fd7ec339bad86af0c4fc10c40 |
|
MD5 | 197d91cf33a1d6c19096b083a211bd66 |
|
BLAKE2b-256 | efec81c882ee608ff3a81f76969cb90ede806cf91a8161fb3e75aae94457ecf6 |