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

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

Built distributions (wheels)

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

Total release size: 65.0 kB

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

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

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

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

Download URL actions_includes-0.0.post40-py3-none-any.whl
Size 13.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
27ca6728b5ac8dc7115e857fd89dfa38a0ac420fd7ec339bad86af0c4fc10c40
BLAKE2b-256 checksum
How to use checksums
efec81c882ee608ff3a81f76969cb90ede806cf91a8161fb3e75aae94457ecf6
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.post40

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