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

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

Built distributions (wheels)

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

Total release size: 65.0 kB

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

Download URL actions-includes-0.0.post45.tar.gz
Size 18.0 kB
Tags Source
SHA-256 checksum
How to use checksums
5b67091b158b45165a5087cc77cbbd64caf13bab01965e6f6a0ef96f72eb93f4
BLAKE2b-256 checksum
How to use checksums
2ec51e6853d57b900da5b64084d69f5fee7583206c9056870b9a522390ac9af0
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.post45-py3.9.egg

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

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

Download URL actions_includes-0.0.post45-py3-none-any.whl
Size 13.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
246648d269a71163772c7332131549aa0a45a44375304dabef5d2cda1d94be15
BLAKE2b-256 checksum
How to use checksums
368808bee3f5826e9ee175204797df80a7de0594c617c8116e9c5fc5e095fba7
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.post45

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