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

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

Built distributions (wheels)

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

Total release size: 111.5 kB

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

Download URL actions-includes-0.0.post69.tar.gz
Size 25.9 kB
Tags Source
SHA-256 checksum
How to use checksums
69a472228f0aad086fb8800ff5b2bc2f9b1e5171399309c6089400c4817c912a
BLAKE2b-256 checksum
How to use checksums
227da48af437e2e4c01cd9816321243047d030dbf9fe4dae0663c71aa086f123
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.post69-py3.9.egg

Download URL actions_includes-0.0.post69-py3.9.egg
Size 32.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
9f790f48c400a7d60caec557d9c4e2543708771752cd14ee9ef57979aebb5efe
BLAKE2b-256 checksum
How to use checksums
6b54a47dd3048feca55e8c554ed7d1b59a3f253d9114a30627b86f5a2825e0b5
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.post69-py3.8.egg

Download URL actions_includes-0.0.post69-py3.8.egg
Size 32.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
e907bb8379c359f1d23e4f8266e7f3c81cdb6b17b2f0f4620e917b8850c14f92
BLAKE2b-256 checksum
How to use checksums
a387a9b162c272c953646fb10e4721c3e55d51a46d6d58d46ac2aa258885ce2e
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.post69-py3-none-any.whl

Download URL actions_includes-0.0.post69-py3-none-any.whl
Size 19.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2d9c183bd848857a03d186fc232292ad5ecce6fb7f036034df1e4c6f599bb144
BLAKE2b-256 checksum
How to use checksums
f7efd04d4cd9e926cdfcfb250eb35635015884067958a266fc652dd9bb6e9e5e
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.post69

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