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

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

Built distributions (wheels)

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

Total release size: 65.0 kB

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

Download URL actions-includes-0.0.post44.tar.gz
Size 18.0 kB
Tags Source
SHA-256 checksum
How to use checksums
8111669c6ffb1944b828d8a70df5c4ae5f34745bf90a4d64dbe52ddfddd1a8a6
BLAKE2b-256 checksum
How to use checksums
3b43b9c300078735290f102790d28e193e41a4d83b088c47097b6e13703d2c2f
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.post44-py3.9.egg

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

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

Download URL actions_includes-0.0.post44-py3-none-any.whl
Size 13.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
aa5fe93c658113ca8f1e47b886e20d1ffa3a8d754c7b00b3261d3720a791f133
BLAKE2b-256 checksum
How to use checksums
9348b20098d19d74a77ee976b49a4a80596a0deb6ca64a7a5ae2802f178002c1
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.post44

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