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

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

Built distributions (wheels)

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

Total release size: 63.8 kB

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

Download URL actions-includes-0.0.post32.tar.gz
Size 16.8 kB
Tags Source
SHA-256 checksum
How to use checksums
d1f9018d41516499063eaf32291c1343980281d8f20da713c76108eb35f50876
BLAKE2b-256 checksum
How to use checksums
99bc0cfca835b8416ee0a1d52aa424ef7cd9b22b05bc9f0595a3de5621f702a6
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.post32-py3.9.egg

Download URL actions_includes-0.0.post32-py3.9.egg
Size 16.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
4cd49498c881cf2a4bee6be54524a363f10996ab304dab97af093ab2086f0af8
BLAKE2b-256 checksum
How to use checksums
c84d2cdb1740006d18e375a7c9e9eb8f0a031fc5a33d50cb8f98451ca7cb6ff5
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.post32-py3.8.egg

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

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

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