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

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

Built distributions (wheels)

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

Total release size: 67.6 kB

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

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

Download URL actions_includes-0.0.post57-py3.9.egg
Size 17.5 kB
Tags Egg
SHA-256 checksum
How to use checksums
87a8e4b9552ba1861590485988d03bea529dafacc1bb721c94a372b85c03694d
BLAKE2b-256 checksum
How to use checksums
8fa126360ea146c9989e7b2001c902e0147bc5f6eb18bad58237821c4af0a677
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.post57-py3.8.egg

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

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

Security for actions-includes 0.0.post57

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