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

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

Built distributions (wheels)

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

Total release size: 67.3 kB

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

Download URL actions-includes-0.0.post56.tar.gz
Size 18.9 kB
Tags Source
SHA-256 checksum
How to use checksums
b8fed80a3eb5e6d57c16be4a39e7c50977353f92d7d3b950293792c05ebb4b1f
BLAKE2b-256 checksum
How to use checksums
da8475e328058bde191d5f5fd0027fd2874af9a901e935c5534a5121afbf5be5
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.post56-py3.9.egg

Download URL actions_includes-0.0.post56-py3.9.egg
Size 17.4 kB
Tags Egg
SHA-256 checksum
How to use checksums
b2c1df3eca6ed132fc8192744f3579a32022c460aafc02502a44f81581e535f6
BLAKE2b-256 checksum
How to use checksums
24e585abd48a3dc6c59e72b9c5186f4d813170ebef9b3b294da1549186222ade
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.post56-py3.8.egg

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

Download URL actions_includes-0.0.post56-py3-none-any.whl
Size 13.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e3e296d23fd8c10264c796fe07e3824b3846f93329db141ae3d26ebd123bb9b4
BLAKE2b-256 checksum
How to use checksums
72a03986d560eda6e7037e43ba0dfd750e512bbf589fa1b82926b30c1417d83b
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.post56

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