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.post55.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0c364bf1f8fb7d2902c7f363c7fafdb02adc407d39f38bb03ca0eee1a5ec3e8 |
|
MD5 | 3f2b825f62b773b4960f7ad2d0253ca1 |
|
BLAKE2b-256 | 4eceb5b661ae4a17d4f2429532a2fe358dd53b593ce981d98f90934273ef61d5 |
Hashes for actions_includes-0.0.post55-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6f9bfd449ebac660f948608992892704fd55e04c11fafdabaeb8a3c2fbe82bd4 |
|
MD5 | 506513ec81e6b670a60a3edaa60c9620 |
|
BLAKE2b-256 | e04af093d39072c62464eea2bf877349fd4405a979dd4c4481f858f11f730585 |
Hashes for actions_includes-0.0.post55-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 79c006befed7313e54dfc88864ee05cf14c1975297207866feb2ee33d8e27dcd |
|
MD5 | 765e33fe09b31fb80e3163ad44fccde8 |
|
BLAKE2b-256 | 769518518d1e887febe50c9496841e69bccaccaae497b64ef25debdf433e0022 |
Hashes for actions_includes-0.0.post55-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 839eb70b2bcae12bd095dcd57a0133412138f6ead6b84c84e24d8cbbd27f1a63 |
|
MD5 | 0fe55c71d5b495c5db9171c3c3d0fce3 |
|
BLAKE2b-256 | 66ba1ab841653d0b76b2ecb4c84e0cb57655f768a1537d94be3c3ccd5cf40872 |