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

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

Built distributions (wheels)

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

Total release size: 67.7 kB

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

Download URL actions-includes-0.0.post58.tar.gz
Size 19.0 kB
Tags Source
SHA-256 checksum
How to use checksums
8288c3292602ff4738a5f284f68abdcc9fadaf4e0ece641898c29c6f3c694bb4
BLAKE2b-256 checksum
How to use checksums
f37a58df14abfc2c4ba07ee677713c34df145c26fef885c640f95ed01743d366
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.post58-py3.9.egg

Download URL actions_includes-0.0.post58-py3.9.egg
Size 17.5 kB
Tags Egg
SHA-256 checksum
How to use checksums
3dffbc1723e4f7e8fa1fd730af7154eeb6cccd9205231bc8fd90984375644d5a
BLAKE2b-256 checksum
How to use checksums
8919b8ef7f667d51759b77fa881f980ae50c0c695bd3a33718ae91b05f89d0b3
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.post58-py3.8.egg

Download URL actions_includes-0.0.post58-py3.8.egg
Size 17.4 kB
Tags Egg
SHA-256 checksum
How to use checksums
f42273e2a1510298799a413cb6f6b9663809c4478658a8422de0c60ae15d8f71
BLAKE2b-256 checksum
How to use checksums
dd7dcdb941877ac77f4833a4ffab11a96d659a849f52456f58fda6ed23548533
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.post58-py3-none-any.whl

Download URL actions_includes-0.0.post58-py3-none-any.whl
Size 13.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a4cfa0ba1528c36cf6af32619b8b8144c901454492ddb23a369bd8bb74b37310
BLAKE2b-256 checksum
How to use checksums
fdef9650c054c0f9628f383d5dbdb457c583d4de68849b0b559354c7c83cbb3f
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.post58

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