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

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

Built distributions (wheels)

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

Total release size: 65.0 kB

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

Download URL actions-includes-0.0.post39.tar.gz
Size 17.9 kB
Tags Source
SHA-256 checksum
How to use checksums
d37aad83a4775a348b6d47dd080a3deb7cadc6716b3d7dbcb421463ec5f2c537
BLAKE2b-256 checksum
How to use checksums
1420ad0858d34d865f35f45b09b42149edc18913821a53d4ac8f50f941d4a521
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.post39-py3.9.egg

Download URL actions_includes-0.0.post39-py3.9.egg
Size 16.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
51289d32b06f0abfe40d556929cd4bf2b24b17260243280df04a586ea91c2ebe
BLAKE2b-256 checksum
How to use checksums
684a5f750dc3639c69f8ab7a10d63c4414c5f33ae8018fbcd1bc4ce0fdb15acc
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.post39-py3.8.egg

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

Download URL actions_includes-0.0.post39-py3-none-any.whl
Size 13.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5214dc25bdfe23a69358774c16a377d4d8763601eac9cb6170ae64240232941e
BLAKE2b-256 checksum
How to use checksums
0640985eb02be0f3ed23c3780d09fa0637d70d22b6667a24eb840883e2cb39f6
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.post39

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