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

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

Built distributions (wheels)

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

Total release size: 67.7 kB

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

Download URL actions-includes-0.0.post59.tar.gz
Size 19.0 kB
Tags Source
SHA-256 checksum
How to use checksums
6c220ce968b2660b43ae33cd411b08e2acec95b32e3a978d7c7c135af6b1223f
BLAKE2b-256 checksum
How to use checksums
0b2313fafc1bd97eb94ddad33a15660be62fbc45c34be1ac65ef0a86d40f5b19
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.post59-py3.9.egg

Download URL actions_includes-0.0.post59-py3.9.egg
Size 17.5 kB
Tags Egg
SHA-256 checksum
How to use checksums
a8a6e5a8243a034b2364d49aa634e4f533f96bcd94f2c1a0001318044cec5c32
BLAKE2b-256 checksum
How to use checksums
43e003326c44a7053eb74926786b1ac81abf0d6d2ea876f1082fbfe8931236d9
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.post59-py3.8.egg

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

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

Security for actions-includes 0.0.post59

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