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.post56.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8fed80a3eb5e6d57c16be4a39e7c50977353f92d7d3b950293792c05ebb4b1f |
|
MD5 | 58da7db7ce977717ace4cc3f6c5edb12 |
|
BLAKE2b-256 | da8475e328058bde191d5f5fd0027fd2874af9a901e935c5534a5121afbf5be5 |
Hashes for actions_includes-0.0.post56-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2c1df3eca6ed132fc8192744f3579a32022c460aafc02502a44f81581e535f6 |
|
MD5 | 02a2966779690549bbed83ce8a696f83 |
|
BLAKE2b-256 | 24e585abd48a3dc6c59e72b9c5186f4d813170ebef9b3b294da1549186222ade |
Hashes for actions_includes-0.0.post56-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 791ed6df056e2e251f12c21ad924b48c5eac3c5731c3a8bb93b78e35594fec14 |
|
MD5 | 884a9c6dd9c4a5bf4414c5489e950e8d |
|
BLAKE2b-256 | 4c47a9fa11dcaa2e3804f80d896b9a5338693e7b912798c35aeb78672cb7a476 |
Hashes for actions_includes-0.0.post56-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3e296d23fd8c10264c796fe07e3824b3846f93329db141ae3d26ebd123bb9b4 |
|
MD5 | 8c5445dddc3f0d51a193aa5cb2230fb0 |
|
BLAKE2b-256 | 72a03986d560eda6e7037e43ba0dfd750e512bbf589fa1b82926b30c1417d83b |