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.post48.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 163c368b9f7bfe9961378ae69b7b2fa6162ab01d7b79260fbccc0ac4a0d08a83 |
|
MD5 | 8c41385ee239212d7ce572a364d658be |
|
BLAKE2b-256 | 1b5890413b5594a401b0adfd2977dae09ac03cb010b03beac6eff8f966273d78 |
Hashes for actions_includes-0.0.post48-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 710b78d85b12ea17f54f90a95f463fcdaf774e9427f991a45fee26a22a34ccf6 |
|
MD5 | aecaaf2e41f02b1d9a211f4ef0ff0c56 |
|
BLAKE2b-256 | 2e03662965a1209cc717195ed26a0a6c745561264f1c19a628d37f4a7fb5a294 |
Hashes for actions_includes-0.0.post48-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 719f4d59f7afa6f04dc8f6929488c53228daf962ce377d88f19895d902a598a6 |
|
MD5 | 4f3813dafc866e6b14fa6c18fdc50b12 |
|
BLAKE2b-256 | 5f81ed8a94ba5a5d4ad8f3a54a83bee7c17bcbba079a84730b3e7b775a777ee2 |
Hashes for actions_includes-0.0.post48-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 02b891cc4f8d06ae0741d1f6138749df9b596987f482e766bdf925f771e859f6 |
|
MD5 | 735797200284875b50a44cc058000e6c |
|
BLAKE2b-256 | 4fbae3ed0ef27d10a0fb16ea3a7d6874c835795b58822bc6abdf0ddc721f72fc |