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

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

Built distributions (wheels)

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

Total release size: 64.7 kB

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

Download URL actions-includes-0.0.post34.tar.gz
Size 17.7 kB
Tags Source
SHA-256 checksum
How to use checksums
6d7886b94665b3756bde0ae7ed7f5e0e239e96d3b5ab6ac8e0506d79be233e7e
BLAKE2b-256 checksum
How to use checksums
011098f9639f9bf462b16739dfcf127891d1ed3f305d5a9d3fd1d418176f170c
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.post34-py3.9.egg

Download URL actions_includes-0.0.post34-py3.9.egg
Size 16.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
ddfbc324dad07249355b0cf1b4932bea6bb00aeb98233bfe0c687ad08457448f
BLAKE2b-256 checksum
How to use checksums
0f2dd90b7236c1de5590660d7be61fa0e3b8308cc43f12c4e5efac1d4c5b16e0
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.post34-py3.8.egg

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

Download URL actions_includes-0.0.post34-py3-none-any.whl
Size 13.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e36c99a25db2ddc58f7489a9b60348d498fdf749d14e074b4c6ddc855444678a
BLAKE2b-256 checksum
How to use checksums
91a5935b30481d236a7a5ac8a51453721570dca36b4c5f6fe5eea3d9e99b46a4
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.post34

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