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.post53.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8473893fb70a0d9f77a6c49ae986abba523cb1b0fc64721a2d2b2d29a9ef3d22 |
|
MD5 | c65678bea6e6a3d6296993517a070f8a |
|
BLAKE2b-256 | 53fa82ef698d16507b9a1731485fddb78b4df568543a773daa28835d77622603 |
Hashes for actions_includes-0.0.post53-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c6c6f8ae7bd53f84eca83001386a9c0b5272b96eb949fbd7f44427a8989734c |
|
MD5 | 546d57085a18504bf491f043f8036ee2 |
|
BLAKE2b-256 | 83a39e8eb013a851832a8c776eb4088412eab6396912b21d8d8ddcddf25b6841 |
Hashes for actions_includes-0.0.post53-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | a68e90a662feea2a6e249b573ad546fd03f0ebdd768c1b8fcbe1e8178981220c |
|
MD5 | 0d279fb8dd672608f2ea311993884698 |
|
BLAKE2b-256 | e1a27d8e250232b45e35f1e2e7aefc73bd92a4d37ae6db53e28beabb9b4fe856 |
Hashes for actions_includes-0.0.post53-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 75cc9b595eb58cf25523eb445bd5919e88f69f0831f6cd9ec6cad3af98c386f4 |
|
MD5 | 0d45e5512ed1dd94c330b483a03942f3 |
|
BLAKE2b-256 | d00f5263fca7c42903c172d2e04d274f5147ac0d023eaf123791846a9c1fd618 |