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
includes:
step
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.
includes-script:
step
File: script.py
print('Hello world')
File: workflow.yml
steps: - name: Other step run: | command - name: Hello includes-script: script.py - name: Other step run: | command
python -m actions_includes.py workflow.in.yml workflow.out.yml
File: oworkflow.out.yml
steps: - name: Other step run: | command - name: Hello shell: python run: | print('Hello world') - name: Other step run: | command
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.post67.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4168d90394af7acd195fa5d50747872cb4296e2e2d6f1264f4c4913a411c080b |
|
MD5 | 592e4361b86c4ac8b6e8a45fc2cd6d59 |
|
BLAKE2b-256 | 3ba39972f2134caa2589f1a7c91032426bf9fdd8c5ae62ff9c29373e6862682d |
Hashes for actions_includes-0.0.post67-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | c08b6a54e2646c18f1612174fb1d7fb929ec82c61fcfcffcec3760eab4d0a055 |
|
MD5 | c5688a284dbbba14e3b0cc50997130ac |
|
BLAKE2b-256 | 60640782c6ad93e32c277dd8e510429b4f157c7ada901efa514a9f1b8e7944ea |
Hashes for actions_includes-0.0.post67-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad284b47705cb82b75a2f8fc96a90a7bd5138f31a3004b626d116ff017533ef5 |
|
MD5 | b9b18a1e500588c20de886b340c7f784 |
|
BLAKE2b-256 | 9607e21245ccfe5b880f46cb91618e4ede0eb727d8ede9b6937d1ede8bb26ced |
Hashes for actions_includes-0.0.post67-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e186d460b3979516bfd1e52a852e5fce4514ce1ada56b97156745eda6a94dc1 |
|
MD5 | 20d5219fde4b3c0f7767701e1076e3df |
|
BLAKE2b-256 | ed91517685dafef959d068dc1057fc1cecaea3496391bec02237a004baf2e00b |