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

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

Built distributions (wheels)

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

Total release size: 115.9 kB

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

Download URL actions-includes-0.0.post73.tar.gz
Size 26.5 kB
Tags Source
SHA-256 checksum
How to use checksums
8df6d0337224943d6025b3658459c2a27a89f31a7df882e9fe5440e2da90deb1
BLAKE2b-256 checksum
How to use checksums
64712771ec003ad96b1d73fe36cfa096b6cf49cb168110268aace5c4e42f18a8
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.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

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

Download URL actions_includes-0.0.post73-py3.9.egg
Size 34.3 kB
Tags Egg
SHA-256 checksum
How to use checksums
12d90bcc089c92e3db44aa805186f79e6321bab44d9d888ef56f89f5e6977980
BLAKE2b-256 checksum
How to use checksums
871759ef9e09e83cd6f735c8c2354fa5ac284f9083d0e3f4c9978c83dd61a218
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.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

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

Download URL actions_includes-0.0.post73-py3.8.egg
Size 34.4 kB
Tags Egg
SHA-256 checksum
How to use checksums
1a2942173e239834010315bada36de0d933f6be4d8516b0ecfbca8997fa7475d
BLAKE2b-256 checksum
How to use checksums
d59c07a3bc559558c3882430efb18ec14e4a00f9b8f6f3c2e0c03eca6bf8415c
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.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

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

Download URL actions_includes-0.0.post73-py3-none-any.whl
Size 20.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
71e21b53b352e7445818953d9389e815d91251e0c626327522339857088e096b
BLAKE2b-256 checksum
How to use checksums
4d0aca63fb43913bb0d97987c16aa75283e7754e7918dd17e96ed2589073032e
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.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Security for actions-includes 0.0.post73

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