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

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

Built distributions (wheels)

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

Total release size: 64.9 kB

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

Download URL actions-includes-0.0.post38.tar.gz
Size 17.9 kB
Tags Source
SHA-256 checksum
How to use checksums
4ebb56d5b03b12cd984dc98ed1c483d96ef53f9ae35f5b1c6020f97fef7e7698
BLAKE2b-256 checksum
How to use checksums
601b615d2a2518cbc78b9924bfdcca4bec311b4fab022b1d57ead76841e6cd92
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.post38-py3.9.egg

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

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

Download URL actions_includes-0.0.post38-py3-none-any.whl
Size 13.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
211a7e956edf3f0b59776bfcb78448f50bed444125f84d34a45cd368eff2d956
BLAKE2b-256 checksum
How to use checksums
02966ddec3b5948b218aeb03a215db3903de07a62c09d998bf31d7fc68146970
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.post38

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