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

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

Built distributions (wheels)

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

Total release size: 112.4 kB

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

Download URL actions-includes-0.0.post70.tar.gz
Size 26.1 kB
Tags Source
SHA-256 checksum
How to use checksums
c6dd1c1173d03528da3fb4d477d42f43658f3129b457d42a8b72af05ceb28da6
BLAKE2b-256 checksum
How to use checksums
6be5d9816efd696eeb7e76d70f80f6174e637c0161758f370ac23b22e12e1da7
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.post70-py3.9.egg

Download URL actions_includes-0.0.post70-py3.9.egg
Size 33.1 kB
Tags Egg
SHA-256 checksum
How to use checksums
c6d51d237106bf3fa927e8352b8b0ff5f8ed6dd43e311ac1acfac4e1dc761399
BLAKE2b-256 checksum
How to use checksums
65da9e109768271fe0b7abcf1a025eb0f148cf7ed370803a1ef3fbd2e8e24e54
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.post70-py3.8.egg

Download URL actions_includes-0.0.post70-py3.8.egg
Size 33.2 kB
Tags Egg
SHA-256 checksum
How to use checksums
9e3e75381650e1afb1cf80003f32488a390b6f82d14aad7dd7a4324f6f03b6ad
BLAKE2b-256 checksum
How to use checksums
fd171dace8928432f9a9679cb5f79a9d2af6e991d266e4d2cf7939913687175d
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.post70-py3-none-any.whl

Download URL actions_includes-0.0.post70-py3-none-any.whl
Size 20.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5ae924ee5ef2bf2e6ff60ea4f420d90a18406e96b79df5e72491611f63f90886
BLAKE2b-256 checksum
How to use checksums
8a77e7df562ba6e8d2eb14244a5c013616181421e49c9973e90ab46bebac5a4a
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

Security for actions-includes 0.0.post70

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