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

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

Built distributions (wheels)

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

Total release size: 66.0 kB

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

Download URL actions-includes-0.0.post48.tar.gz
Size 18.5 kB
Tags Source
SHA-256 checksum
How to use checksums
163c368b9f7bfe9961378ae69b7b2fa6162ab01d7b79260fbccc0ac4a0d08a83
BLAKE2b-256 checksum
How to use checksums
1b5890413b5594a401b0adfd2977dae09ac03cb010b03beac6eff8f966273d78
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.post48-py3.9.egg

Download URL actions_includes-0.0.post48-py3.9.egg
Size 16.9 kB
Tags Egg
SHA-256 checksum
How to use checksums
710b78d85b12ea17f54f90a95f463fcdaf774e9427f991a45fee26a22a34ccf6
BLAKE2b-256 checksum
How to use checksums
2e03662965a1209cc717195ed26a0a6c745561264f1c19a628d37f4a7fb5a294
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.post48-py3.8.egg

Download URL actions_includes-0.0.post48-py3.8.egg
Size 16.9 kB
Tags Egg
SHA-256 checksum
How to use checksums
719f4d59f7afa6f04dc8f6929488c53228daf962ce377d88f19895d902a598a6
BLAKE2b-256 checksum
How to use checksums
5f81ed8a94ba5a5d4ad8f3a54a83bee7c17bcbba079a84730b3e7b775a777ee2
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.post48-py3-none-any.whl

Download URL actions_includes-0.0.post48-py3-none-any.whl
Size 13.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
02b891cc4f8d06ae0741d1f6138749df9b596987f482e766bdf925f771e859f6
BLAKE2b-256 checksum
How to use checksums
4fbae3ed0ef27d10a0fb16ea3a7d6874c835795b58822bc6abdf0ddc721f72fc
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.post48

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