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

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

Built distributions (wheels)

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

Total release size: 62.5 kB

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

Download URL actions-includes-0.0.post31.tar.gz
Size 17.2 kB
Tags Source
SHA-256 checksum
How to use checksums
803ca6d224aa913bc292ae613049ea1cf0dd127e8d70048fea01e91b3e16bf05
BLAKE2b-256 checksum
How to use checksums
051630fa0d23383b44a77ec5440ba7572903223d7f8c9759a7f75896f5aeaeef
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.post31-py3.9.egg

Download URL actions_includes-0.0.post31-py3.9.egg
Size 16.2 kB
Tags Egg
SHA-256 checksum
How to use checksums
d2b5e7c39601f56a60d796dd93bb62b9b477f3a52713160e313000ff38f72808
BLAKE2b-256 checksum
How to use checksums
b601eceae09121a75353ffe22f9abfd55f10a1ec565b93668c1af3ef917c5f52
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.post31-py3.8.egg

Download URL actions_includes-0.0.post31-py3.8.egg
Size 16.2 kB
Tags Egg
SHA-256 checksum
How to use checksums
e93d7e421ac8d8f924c979f3ea55185bd436a6eccb545064e4c19e4212f24078
BLAKE2b-256 checksum
How to use checksums
78f04ddf6f193efad338385736c1d718cf2acca47bf1525118dd42bf7efc1aaa
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.post31-py3-none-any.whl

Download URL actions_includes-0.0.post31-py3-none-any.whl
Size 12.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3aae17cebb366aa4a3d0f4394df1fc5ff018718ca2f6e272790b4ba8ccb3839c
BLAKE2b-256 checksum
How to use checksums
fbaf3ed31c91e1b85cb64e2847e7ee451f032eebc42d8a4cc984006ae1873378
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.post31

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