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.post34.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6d7886b94665b3756bde0ae7ed7f5e0e239e96d3b5ab6ac8e0506d79be233e7e |
|
MD5 | d88653e81c599d0044d9a70d7cd1d2ef |
|
BLAKE2b-256 | 011098f9639f9bf462b16739dfcf127891d1ed3f305d5a9d3fd1d418176f170c |
Hashes for actions_includes-0.0.post34-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | ddfbc324dad07249355b0cf1b4932bea6bb00aeb98233bfe0c687ad08457448f |
|
MD5 | 6718e4ca6a27b96bddf4d64bb3bbfb5e |
|
BLAKE2b-256 | 0f2dd90b7236c1de5590660d7be61fa0e3b8308cc43f12c4e5efac1d4c5b16e0 |
Hashes for actions_includes-0.0.post34-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3e1d12b71f650a2ddde2b9d1dca6a89777723f87c4d3e4345cc4c217cb5cab8 |
|
MD5 | 30cd9b1e10377ddb507a244ba0bde345 |
|
BLAKE2b-256 | 1d263aeb2eb336f88bd07ae5b0003eb70f7f4d9ef1558142ebbd3403749caaff |
Hashes for actions_includes-0.0.post34-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e36c99a25db2ddc58f7489a9b60348d498fdf749d14e074b4c6ddc855444678a |
|
MD5 | 7fb14a23e11a952cc41140d5469a4e65 |
|
BLAKE2b-256 | 91a5935b30481d236a7a5ac8a51453721570dca36b4c5f6fe5eea3d9e99b46a4 |