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

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

Built distributions (wheels)

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

Total release size: 64.9 kB

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

Download URL actions-includes-0.0.post37.tar.gz
Size 17.8 kB
Tags Source
SHA-256 checksum
How to use checksums
89f41545809a29107394b89ec0bd1e4ad97aa4f58750ca4f6144b702aa49c72a
BLAKE2b-256 checksum
How to use checksums
b61d7997a77cb9a9801d3ca92d5a88a355f3c6a6eb8b8d0ab762da0a0089ef5e
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.post37-py3.9.egg

Download URL actions_includes-0.0.post37-py3.9.egg
Size 16.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
5585669ff9271a2075a73e1e3b488303644fe63565fed6ae75b7e06fa3163e78
BLAKE2b-256 checksum
How to use checksums
b239b56eed2f30f2e53d67607fa450f8da83e97b60098c1d4513570a0178325d
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.post37-py3.8.egg

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

Download URL actions_includes-0.0.post37-py3-none-any.whl
Size 13.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
22f6e958bed543c3448ce4d1de65ab97257fd8e745de16e71a28f1a2456dd93f
BLAKE2b-256 checksum
How to use checksums
42b366a19dacfd577fac0101bd682a6d102d33001e2098b66b36581da2cb463e
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.post37

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