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

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

Built distributions (wheels)

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

Total release size: 56.3 kB

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

Download URL actions-includes-0.0.post27.tar.gz
Size 16.6 kB
Tags Source
SHA-256 checksum
How to use checksums
ffbcc6a8977d97f0ce0fc95d1154d2b6a198475f232bdf4dba6861f6737db0e3
BLAKE2b-256 checksum
How to use checksums
6bb291503cd722a1d4343529434cd227bb964a32e5cbf04607b9ee2c075a8c0e
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.post27-py3.9.egg

Download URL actions_includes-0.0.post27-py3.9.egg
Size 13.9 kB
Tags Egg
SHA-256 checksum
How to use checksums
2f4d853cdc9100756da49d44f1343649cb6ded4840cd9e8a4299a00bcc8fa7f6
BLAKE2b-256 checksum
How to use checksums
d400cb154fc5618125584be49d77889843c38ee5af3de21d6481c6e30a3b7f98
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.post27-py3.8.egg

Download URL actions_includes-0.0.post27-py3.8.egg
Size 13.9 kB
Tags Egg
SHA-256 checksum
How to use checksums
7ee721edce8c05e3cd36c956d4db378b4c1bbb9dd7050b2775a94992c9aea1fe
BLAKE2b-256 checksum
How to use checksums
b1761da59471c49a82bff1438f283437db042f0ccb042db1683d5eafb94bd13b
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.post27-py3-none-any.whl

Download URL actions_includes-0.0.post27-py3-none-any.whl
Size 11.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
17be838eb5d604b0e2cbcc3b7f905f0a37be13f32994999574f0096e9187941e
BLAKE2b-256 checksum
How to use checksums
d880469f2645ccfa15ffdfcb49813cb1c614fe34d1db854b0730cd28603ddcaa
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.post27

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