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

includes: step

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.

includes-script: step

File: script.py

print('Hello world')

File: workflow.yml

steps:
- name: Other step
  run: |
    command

- name: Hello
  includes-script: script.py

- name: Other step
  run: |
    command

python -m actions_includes.py workflow.in.yml workflow.out.yml

File: oworkflow.out.yml

steps:
- name: Other step
  run: |
    command

- name: Hello
  shell: python
  run: |
    print('Hello world')

- name: Other step
  run: |
    command

Metadata

Release files for actions-includes 0.0.post68

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

Built distributions (wheels)

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

Total release size: 110.9 kB

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

Download URL actions-includes-0.0.post68.tar.gz
Size 25.8 kB
Tags Source
SHA-256 checksum
How to use checksums
80ca5abdca56126e5d6df1263f42f5465e99f7ade3a61b1a6f2980c9dcca0f17
BLAKE2b-256 checksum
How to use checksums
5b18806def9dcd1df86ff5b63b1c4348dd0c5f89d693e3c4c37e7f435423b0b3
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.1.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

Release files / actions_includes-0.0.post68-py3.9.egg

Download URL actions_includes-0.0.post68-py3.9.egg
Size 32.6 kB
Tags Egg
SHA-256 checksum
How to use checksums
f151349d765a92a2d04881e71233b75c1c4812ca33ed572a99ad4236b45987f2
BLAKE2b-256 checksum
How to use checksums
86461c3d478ce7b4b440498a284aff7175e85e421d723bca08df98b2a2316db8
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.1.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Release files / actions_includes-0.0.post68-py3.8.egg

Download URL actions_includes-0.0.post68-py3.8.egg
Size 32.6 kB
Tags Egg
SHA-256 checksum
How to use checksums
519b2035f122b01f18fd51cca5dc6d0a2188a44ac2d033f5ecf5937f5a0cf0f2
BLAKE2b-256 checksum
How to use checksums
6784c8f2d531e096f084b681c27d679f5890b8b8294a33f705ea75d461520981
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.1.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

Release files / actions_includes-0.0.post68-py3-none-any.whl

Download URL actions_includes-0.0.post68-py3-none-any.whl
Size 19.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
da421eeb4fd3e9b7fc9fcb790bda9776f068d4633a5de7d29e9f3984adbe4b34
BLAKE2b-256 checksum
How to use checksums
ba18d490924462aeccde74f855566b5604eae861777c3b12a697bfd5a22efb2d
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.1.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

Security for actions-includes 0.0.post68

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