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

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

Built distributions (wheels)

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

Total release size: 64.7 kB

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

Download URL actions-includes-0.0.post35.tar.gz
Size 17.7 kB
Tags Source
SHA-256 checksum
How to use checksums
5c95fc8ae648482a2aeafac0b494db83b2c2ba11eed205c84343f2a9658f61c7
BLAKE2b-256 checksum
How to use checksums
3c1e21794137713f8eb8c8fcb510bb5db7d63aeab22c0302a8b7d1af1b52fab6
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.post35-py3.9.egg

Download URL actions_includes-0.0.post35-py3.9.egg
Size 16.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
3fbe6aeb291feecff908d301352c59c8661cbbd4ff1008baedcb1d9d11896d2a
BLAKE2b-256 checksum
How to use checksums
73c0256089511a7032d56c82951162eb53632130655217b849d5edacf642ec35
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.post35-py3.8.egg

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

Download URL actions_includes-0.0.post35-py3-none-any.whl
Size 13.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3344edb15de7674ca9e57579e3d8b86bd4333049f91372cded0eb68bf12095c9
BLAKE2b-256 checksum
How to use checksums
0013a4c50e2849da825896b33ae05b479dc7b5d83b105330eecc2f1e6826f550
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

Security for actions-includes 0.0.post35

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