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

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

Built distributions (wheels)

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

Total release size: 67.3 kB

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

Download URL actions-includes-0.0.post55.tar.gz
Size 18.8 kB
Tags Source
SHA-256 checksum
How to use checksums
a0c364bf1f8fb7d2902c7f363c7fafdb02adc407d39f38bb03ca0eee1a5ec3e8
BLAKE2b-256 checksum
How to use checksums
4eceb5b661ae4a17d4f2429532a2fe358dd53b593ce981d98f90934273ef61d5
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.post55-py3.9.egg

Download URL actions_includes-0.0.post55-py3.9.egg
Size 17.4 kB
Tags Egg
SHA-256 checksum
How to use checksums
6f9bfd449ebac660f948608992892704fd55e04c11fafdabaeb8a3c2fbe82bd4
BLAKE2b-256 checksum
How to use checksums
e04af093d39072c62464eea2bf877349fd4405a979dd4c4481f858f11f730585
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.post55-py3.8.egg

Download URL actions_includes-0.0.post55-py3.8.egg
Size 17.3 kB
Tags Egg
SHA-256 checksum
How to use checksums
79c006befed7313e54dfc88864ee05cf14c1975297207866feb2ee33d8e27dcd
BLAKE2b-256 checksum
How to use checksums
769518518d1e887febe50c9496841e69bccaccaae497b64ef25debdf433e0022
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.post55-py3-none-any.whl

Download URL actions_includes-0.0.post55-py3-none-any.whl
Size 13.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
839eb70b2bcae12bd095dcd57a0133412138f6ead6b84c84e24d8cbbd27f1a63
BLAKE2b-256 checksum
How to use checksums
66ba1ab841653d0b76b2ecb4c84e0cb57655f768a1537d94be3c3ccd5cf40872
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.post55

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