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

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

Built distributions (wheels)

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

Total release size: 65.0 kB

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

Download URL actions-includes-0.0.post47.tar.gz
Size 18.0 kB
Tags Source
SHA-256 checksum
How to use checksums
66edc583f1011d2a80e2cf4f7cd0491ef96bb31172c399a18d355b2f66b2ff39
BLAKE2b-256 checksum
How to use checksums
cd623f760bdb7cb9473816cd5caf340e24183a87b6cd8cf9d0edddad7bd52e76
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.post47-py3.9.egg

Download URL actions_includes-0.0.post47-py3.9.egg
Size 16.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
7bb164bb4d3b3e965c78f6c5d44767b88e5c5e0c5f23f7e3aeab89a44f2acff6
BLAKE2b-256 checksum
How to use checksums
a0bfa30695cbf848363e6261db206ba251d3632d903811e9ae8e6a8efbab9fd0
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.post47-py3.8.egg

Download URL actions_includes-0.0.post47-py3.8.egg
Size 16.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
7dd7fa723e7c2751a93d7690d4f081038bd8b068529ab5a5edcaf42a80714235
BLAKE2b-256 checksum
How to use checksums
b096480c2bcb5e853b41da462c98f29beffdbbb1a20075e930f0e53e9f3d151d
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.post47-py3-none-any.whl

Download URL actions_includes-0.0.post47-py3-none-any.whl
Size 13.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
980ff47ac8204cb73b2e919cbcab14d3e70735f08a5c29d23b3b7c91a47fcb9b
BLAKE2b-256 checksum
How to use checksums
f7b930a6e87656a0d78ee1bcc40ef91811e8d375dfafd1f0711971e12ad2437c
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.post47

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