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

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

Built distributions (wheels)

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

Total release size: 65.0 kB

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

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

Download URL actions_includes-0.0.post46-py3.9.egg
Size 16.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
7c0caf0e4cf3188c7612bd8dd69582f908618c8fa507ac5af1b67f11596b616f
BLAKE2b-256 checksum
How to use checksums
d0cd049a746891ce38720a3fbc11b84a505e10aaa12d14f240a4ad2bad2a3502
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.post46-py3.8.egg

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

Download URL actions_includes-0.0.post46-py3-none-any.whl
Size 13.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f76575730c6c86103c046745cc397d7e05d47f4d956ff8451e9c7e4398d1de38
BLAKE2b-256 checksum
How to use checksums
6a0ea7d089d734b8a9104fca9e5ee6167e1457df469370f871dd72a57d19e9fd
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.post46

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