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

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

Built distributions (wheels)

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

Total release size: 67.1 kB

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

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

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

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

Download URL actions_includes-0.0.post54-py3-none-any.whl
Size 13.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cc5b01c28bdbae1e3227f9a1417e7d279d10efd70a32c8330f77067ccc13e2af
BLAKE2b-256 checksum
How to use checksums
da8403ca158e11522d73a807337aafd7e58917838e5a28234fc9a4f3b74eb67c
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.post54

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