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.post46.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 597017b0061c9db18e2708a5dafdbd429559503f2a0a5c183f6d6d5f474ffbae |
|
MD5 | c4358c0124ca84b25c476981257c00c5 |
|
BLAKE2b-256 | d1bf5735368cf67777a02bfb0d4bb029bc985d0cda3eb531dd4c0aebb75a5e53 |
Hashes for actions_includes-0.0.post46-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c0caf0e4cf3188c7612bd8dd69582f908618c8fa507ac5af1b67f11596b616f |
|
MD5 | ef93a873c56fd1cf4a304a34f060c046 |
|
BLAKE2b-256 | d0cd049a746891ce38720a3fbc11b84a505e10aaa12d14f240a4ad2bad2a3502 |
Hashes for actions_includes-0.0.post46-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f1fc01ab759c27e4f78d664efe30116ec91b12d671144dc8acbbcf933566063 |
|
MD5 | aee98c79e56dca9f136051fcf48da1d9 |
|
BLAKE2b-256 | f0b50d679b7e84494f03bbbb3e7f93073a14859825ae2f2eb2a802c47e15706c |
Hashes for actions_includes-0.0.post46-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f76575730c6c86103c046745cc397d7e05d47f4d956ff8451e9c7e4398d1de38 |
|
MD5 | c745a80b5da9b3c31e7cff4696ed31eb |
|
BLAKE2b-256 | 6a0ea7d089d734b8a9104fca9e5ee6167e1457df469370f871dd72a57d19e9fd |