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
The shell parameter is deduced from the file extension, but it is possible to
use a custom shell by setting the shell parameter manually.
Release files for actions-includes 0.0.post99
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| actions-includes-0.0.post99.tar.gz | 34.2 kB | Without provenance | Details |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| actions_includes-0.0.post99-py3.9.egg | Legacy Egg format | - | - | Details |
| actions_includes-0.0.post99-py3.8.egg | Legacy Egg format | - | - | Details |
| actions_includes-0.0.post99-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 169.7 kB
Release files / actions-includes-0.0.post99.tar.gz
| Download URL | actions-includes-0.0.post99.tar.gz |
|---|---|
| Size | 34.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4d9b434ea1625b9fb40791dd51a42b6b30a1bbdd294941013e3098c0b6709feb
|
|
BLAKE2b-256 checksum How to use checksums |
ef42ac96c25b9b9a4ed84ed2c54c1e3d3443acfdbb2997efb29dfca36dfafc27
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8
|
Release files / actions_includes-0.0.post99-py3.9.egg
| Download URL | actions_includes-0.0.post99-py3.9.egg |
|---|---|
| Size | 53.4 kB |
| Tags | Egg |
|
SHA-256 checksum How to use checksums |
47281a40c1390489f815eeaac814cbff23a83d2f5e58a964da4af901d0ef7f9c
|
|
BLAKE2b-256 checksum How to use checksums |
6158f34d0fe7c2440c3b77ceedc3ed2ea69c45df42f1f123dfb8a9dd0043f1ab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2
|
Release files / actions_includes-0.0.post99-py3.8.egg
| Download URL | actions_includes-0.0.post99-py3.8.egg |
|---|---|
| Size | 53.4 kB |
| Tags | Egg |
|
SHA-256 checksum How to use checksums |
9456d36bab73f1c399f9408b68c5b559c43919bd32dc7780ed80a7833de893f9
|
|
BLAKE2b-256 checksum How to use checksums |
5abb800521620db06c8f0f5165a9b1773f1c7a93d6a84c356b51e1fe2b122066
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8
|
Release files / actions_includes-0.0.post99-py3-none-any.whl
| Download URL | actions_includes-0.0.post99-py3-none-any.whl |
|---|---|
| Size | 28.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7abfecd302940df096fb5a94f2d68f3d39c82d7ae1685df458a7a5b13fd9a1f5
|
|
BLAKE2b-256 checksum How to use checksums |
a82120a0e7cd6849a5e587dd8516e790797695b7d69c213397bce4acab0bb090
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8
|
Security for actions-includes 0.0.post99
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
