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

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

Built distributions (wheels)

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

Total release size: 67.1 kB

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

Download URL actions-includes-0.0.post53.tar.gz
Size 18.7 kB
Tags Source
SHA-256 checksum
How to use checksums
8473893fb70a0d9f77a6c49ae986abba523cb1b0fc64721a2d2b2d29a9ef3d22
BLAKE2b-256 checksum
How to use checksums
53fa82ef698d16507b9a1731485fddb78b4df568543a773daa28835d77622603
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.post53-py3.9.egg

Download URL actions_includes-0.0.post53-py3.9.egg
Size 17.4 kB
Tags Egg
SHA-256 checksum
How to use checksums
4c6c6f8ae7bd53f84eca83001386a9c0b5272b96eb949fbd7f44427a8989734c
BLAKE2b-256 checksum
How to use checksums
83a39e8eb013a851832a8c776eb4088412eab6396912b21d8d8ddcddf25b6841
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.post53-py3.8.egg

Download URL actions_includes-0.0.post53-py3.8.egg
Size 17.3 kB
Tags Egg
SHA-256 checksum
How to use checksums
a68e90a662feea2a6e249b573ad546fd03f0ebdd768c1b8fcbe1e8178981220c
BLAKE2b-256 checksum
How to use checksums
e1a27d8e250232b45e35f1e2e7aefc73bd92a4d37ae6db53e28beabb9b4fe856
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.post53-py3-none-any.whl

Download URL actions_includes-0.0.post53-py3-none-any.whl
Size 13.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
75cc9b595eb58cf25523eb445bd5919e88f69f0831f6cd9ec6cad3af98c386f4
BLAKE2b-256 checksum
How to use checksums
d00f5263fca7c42903c172d2e04d274f5147ac0d023eaf123791846a9c1fd618
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

Security for actions-includes 0.0.post53

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