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

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

Built distributions (wheels)

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

Total release size: 65.0 kB

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

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

Download URL actions_includes-0.0.post43-py3.9.egg
Size 16.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
40eed6ed06e86f4f60220dc9c64e21ecc54affe35c69f8ed25b90bdad31189b9
BLAKE2b-256 checksum
How to use checksums
91b13955a54e4ca0ff45808990256ffacfef87b575071d1cb252fe6a678e09e2
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.post43-py3.8.egg

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

Download URL actions_includes-0.0.post43-py3-none-any.whl
Size 13.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
aed6ee5da007fbc55d47858933de72b1423cecd31f21c9a5b605f936883357da
BLAKE2b-256 checksum
How to use checksums
b60ed73ab08a45bfe42b2665be46c6815ee45cd78421feb4cb87fd8481fdeae2
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

Security for actions-includes 0.0.post43

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