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

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

Built distributions (wheels)

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

Total release size: 56.4 kB

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

Download URL actions-includes-0.0.post29.tar.gz
Size 16.7 kB
Tags Source
SHA-256 checksum
How to use checksums
e041832b46049c7bc876ff4fb177ea9178192958efae504f4051934a8057c0a7
BLAKE2b-256 checksum
How to use checksums
14a95a71943744676443ac2a96d5aa04d8333bc34ed8bc2c87a3ee21020dd473
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.post29-py3.9.egg

Download URL actions_includes-0.0.post29-py3.9.egg
Size 13.9 kB
Tags Egg
SHA-256 checksum
How to use checksums
58816c89339ac497424f8c1b456acc3fd3112bf6a2dc65a8947f80b4fb57d85a
BLAKE2b-256 checksum
How to use checksums
8e227a9ddb19b736343e70574e7560fa8c4fcdb6a7b8a78769087968785a7bcf
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.post29-py3.8.egg

Download URL actions_includes-0.0.post29-py3.8.egg
Size 13.9 kB
Tags Egg
SHA-256 checksum
How to use checksums
f99c41bbe0d1da3d559880e9004166c8d57ba38814e3bbeab19d45083a95ef4c
BLAKE2b-256 checksum
How to use checksums
82bb2837c9876ece798990e97f895e71f6d64bf15ad744e8a56794f5d1d6c626
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.post29-py3-none-any.whl

Download URL actions_includes-0.0.post29-py3-none-any.whl
Size 11.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7af47653dee127d3d1ecc029ed3b56d7e7f844bff4617c5ed514d8c9b76392cd
BLAKE2b-256 checksum
How to use checksums
541b83da702ff0563c1ec79e1c69ed488ce80c87b5db543e12bf2c2656c5e673
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.post29

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