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

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

Built distributions (wheels)

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

Total release size: 67.1 kB

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

Download URL actions-includes-0.0.post52.tar.gz
Size 18.7 kB
Tags Source
SHA-256 checksum
How to use checksums
c6f22f4a30473fd950355a6132002150b1ed8f45e51e734a3b26957ca5fa8037
BLAKE2b-256 checksum
How to use checksums
f95e702dcd56d5a6fece154317000a478e1c42afcce60c13cdcff62d1d3e5fc8
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.post52-py3.9.egg

Download URL actions_includes-0.0.post52-py3.9.egg
Size 17.4 kB
Tags Egg
SHA-256 checksum
How to use checksums
fe8fc36a2b71fbb340c6653c2310570b3adb9883734bb98bc10bb7f154ec424b
BLAKE2b-256 checksum
How to use checksums
b5d75a844a5ed3a5cd630f617c9c893b9679233c993c8545a8a59d7c9443ce12
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.post52-py3.8.egg

Download URL actions_includes-0.0.post52-py3.8.egg
Size 17.3 kB
Tags Egg
SHA-256 checksum
How to use checksums
1b5c01d125c047c9856522adc88a572684c7e46e4a7f15432942e46af7e1be14
BLAKE2b-256 checksum
How to use checksums
c789f1f70841943cede685105cac603eaaa49dfa523ba12dbd58222f5716b6ab
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.post52-py3-none-any.whl

Download URL actions_includes-0.0.post52-py3-none-any.whl
Size 13.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9b37b6c85b516d99a9d59bbaca0ae7e787308a7c59bcba5902af9e2c970df595
BLAKE2b-256 checksum
How to use checksums
79e800318fa3ff17cd8cc1413fa1eb70db7bcec72fa15bb68b881c9ec1519b99
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

Security for actions-includes 0.0.post52

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