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

Metadata

Release files for actions-includes 0.0.post36

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

Built distributions (wheels)

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

Total release size: 64.7 kB

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

Download URL actions-includes-0.0.post36.tar.gz
Size 17.7 kB
Tags Source
SHA-256 checksum
How to use checksums
45eabcb0ead39ae4113f471a7813cb654aa728d583ce980eedf338a41a1bfc24
BLAKE2b-256 checksum
How to use checksums
2516aaa44d9820546429ef90aa5d02d8c1212ea90ce6bf5eb34ecd2e7e36d1ef
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/53.1.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

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

Download URL actions_includes-0.0.post36-py3.9.egg
Size 16.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
013cf27b7aaa730df7729902152729b4b8db28cc23731e7f7bd566fa8d713f73
BLAKE2b-256 checksum
How to use checksums
85f8d3d826c02531a7e5ba3c2dd7424f941f429a8d10335f38d2db9a38710e18
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/53.1.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.1

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

Download URL actions_includes-0.0.post36-py3.8.egg
Size 16.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
66a1fe7202edd5525dbc9cb69cb68225ab159d84cc68997498d888fa8eb29af2
BLAKE2b-256 checksum
How to use checksums
b00b03cced1ab25b8a0182c0807baa0e4c1270a536d472fe9839bce86d91168b
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/53.1.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

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

Download URL actions_includes-0.0.post36-py3-none-any.whl
Size 13.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
71567f982b02faaff9c1ef1ef3aaa59c6f9590d9b0a573b793c7009c1d34692f
BLAKE2b-256 checksum
How to use checksums
751618b0706e9fc551bae66973b05db5bd1f338a65b5228df9d7f23e5b1e7582
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/53.1.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

Security for actions-includes 0.0.post36

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