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.post61

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.post61
File Size Uploaded Provenance
actions-includes-0.0.post61.tar.gz 20.3 kB Without provenance Details

Built distributions (wheels)

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

Total release size: 71.9 kB

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

Download URL actions-includes-0.0.post61.tar.gz
Size 20.3 kB
Tags Source
SHA-256 checksum
How to use checksums
7ef1dce8a8644f6bb3a1403f29d4742b3880ce1ca927ca9cb0f68f5c76e6f164
BLAKE2b-256 checksum
How to use checksums
2bae1d31a97d569dddb706142c713c22d49c0941f3d2342d59989678869a8719
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.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

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

Download URL actions_includes-0.0.post61-py3.9.egg
Size 18.7 kB
Tags Egg
SHA-256 checksum
How to use checksums
0d55af8af673d8c03dbfc7bd83ab5b07a96a481f1e3a30b628a1f8c5257cae88
BLAKE2b-256 checksum
How to use checksums
70e0c94489f3ec0027cfbd548a0008c9ffce99e8bd75894d2d640d300a417114
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.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.1

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

Download URL actions_includes-0.0.post61-py3.8.egg
Size 18.6 kB
Tags Egg
SHA-256 checksum
How to use checksums
5825bb90bdbb049d5d7327e082788eb03f55b0867181b68b152f97307a649dfc
BLAKE2b-256 checksum
How to use checksums
6d21168f129a44b3793af9ffacdcb613e69e7a8d11902fd71415faefddac9b1b
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.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

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

Download URL actions_includes-0.0.post61-py3-none-any.whl
Size 14.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
63006d38c2fbdeab6a35fe42b06095c1b57bf96478430e9765720ff9aa758825
BLAKE2b-256 checksum
How to use checksums
51b17671cf9a005c6fbc39638ccd430d1813c39736608f7886a24eabb556faca
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.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

Security for actions-includes 0.0.post61

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.post61 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