Skip to main content

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 in github.com/{owner}/{repo}
  • {owner}/{repo}/{path}@{ref} - Public action under {path} in github.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

Metadata

Release files for actions-includes 0.0.post71

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for actions-includes 0.0.post71
File Size Uploaded Provenance
actions-includes-0.0.post71.tar.gz 26.2 kB Without provenance Details

Built distributions (wheels)

Table of built distributions (wheels) for actions-includes 0.0.post71
File Interpreter ABI Platform
actions_includes-0.0.post71-py3.9.egg Legacy Egg format - - Details
actions_includes-0.0.post71-py3.8.egg Legacy Egg format - - Details
actions_includes-0.0.post71-py3-none-any.whl Python 3 none any Details

Total release size: 113.2 kB

Release files / actions-includes-0.0.post71.tar.gz

Download URL actions-includes-0.0.post71.tar.gz
Size 26.2 kB
Tags Source
SHA-256 checksum
How to use checksums
d300005ebbc7dd672054fb7916ef0d920333edacf5ed9378033d89f25e3a10db
BLAKE2b-256 checksum
How to use checksums
e7105599c7a4f9c3f85fb3de6e379fa9c2460b53b0501b2f8672df58baa84adb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.1.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Release files / actions_includes-0.0.post71-py3.9.egg

Download URL actions_includes-0.0.post71-py3.9.egg
Size 33.4 kB
Tags Egg
SHA-256 checksum
How to use checksums
d814e377fb1bec9b9df274d1b7f1431c5e9dd759b105769637880be527c30347
BLAKE2b-256 checksum
How to use checksums
253ce5b521e7db1d61dfb607b3f05426207d34c06efc340a00ed9af32b9654ad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.1.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Release files / actions_includes-0.0.post71-py3.8.egg

Download URL actions_includes-0.0.post71-py3.8.egg
Size 33.4 kB
Tags Egg
SHA-256 checksum
How to use checksums
2f8b248b9ee8dcb89313ced3a521b3796b9ef8c07dacdad46947c3e8f431458d
BLAKE2b-256 checksum
How to use checksums
8e70f9e0efd6975de91e50608c1b5166d47ebfd2aad73b24170706decb93574c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.1.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

Release files / actions_includes-0.0.post71-py3-none-any.whl

Download URL actions_includes-0.0.post71-py3-none-any.whl
Size 20.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1965d17266687b862a8b5abf77b07264607634eb73aead8ca7f360e25d2f0f42
BLAKE2b-256 checksum
How to use checksums
8149f5b9bf49e29b92f93d3fb4f408f9f92578ed6ef51a3c969bc31482446802
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.1.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

Security for actions-includes 0.0.post71

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.

Release history Release notifications | RSS feed

This release

0.0.post71 This release

4 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page