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.post79.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5265fe0cb7edf294d8db65bc4f8618fbd9e61d19abda26984001935c13765dea |
|
MD5 | cd4692f139dee7a68112ddda8c7ba1eb |
|
BLAKE2b-256 | 41916f29de1358e3647738da5dfadb5959156fcd027759a0a34aa09cad8c4277 |
Hashes for actions_includes-0.0.post79-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8c9f7fdbc2676337b4acd8c34a2202fab479db9d13f070d84e9c1e64f22438c |
|
MD5 | 8ac455356d4220764d31422a46f867d1 |
|
BLAKE2b-256 | ba103c83ee1e00a30a60332a25940a23671532bd4f7c7b6884a412485d28eb2e |
Hashes for actions_includes-0.0.post79-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6304867ee89aa80aca88a15e5f17abd96a5bda3bc0c8d7052d697f21f24ad653 |
|
MD5 | 6027ba86c9075ddc61e78a87c316a60f |
|
BLAKE2b-256 | 88259513c120c7689a27a1294cb59ef02963b9b44662ae89de4898243f4ddbb6 |
Hashes for actions_includes-0.0.post79-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e1bf2d4d85f8df9302c9777a87c7a44fdd50d7d03008576600ae358bd8fcf6d9 |
|
MD5 | 93a185e6122b9a9ccc2bd3cce609fc69 |
|
BLAKE2b-256 | 7ac33007b9a9f4b09cd07122d416928d8b5481f36bd3e1ce0297a7f7e6cdd991 |