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

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

Built distributions (wheels)

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

Total release size: 65.0 kB

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

Download URL actions-includes-0.0.post42.tar.gz
Size 18.0 kB
Tags Source
SHA-256 checksum
How to use checksums
aa874520d485f610b8f6bad1c03445498a26122a8a52c14747b25bf155341b14
BLAKE2b-256 checksum
How to use checksums
91afa8d6adb8b47d2a6954f6a635b351ec36a2bb07d5b89f2f0903747eadcba9
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.post42-py3.9.egg

Download URL actions_includes-0.0.post42-py3.9.egg
Size 16.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
68c2de539cb86acc0b86c6c2e58228f09c4860f7a4f3b0a6586210d9929c8130
BLAKE2b-256 checksum
How to use checksums
66cb83fdb66873855b995e3210c4e5aafbe99cd0c9398c5d431cb4755c9aaa0d
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.post42-py3.8.egg

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

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

Security for actions-includes 0.0.post42

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