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

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

Built distributions (wheels)

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

Total release size: 117.9 kB

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

Download URL actions-includes-0.0.post78.tar.gz
Size 26.9 kB
Tags Source
SHA-256 checksum
How to use checksums
8f7d4941f187afa31133b57bcfebd5518758adb5f68a0746472329ca5b1a6f8d
BLAKE2b-256 checksum
How to use checksums
5fb19a1828ddd6b99876c2a4b8211b0b503fada8174bd23722eed710b8b718cc
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.post78-py3.9.egg

Download URL actions_includes-0.0.post78-py3.9.egg
Size 35.0 kB
Tags Egg
SHA-256 checksum
How to use checksums
8419fe5db543ff444f1be031686f620b43fcc4f8121aed28a28140cc391cf648
BLAKE2b-256 checksum
How to use checksums
e427a47c1ff9b778c7fd5749f7fc67cab12520a6326f89cceb87a65c7d5793af
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.post78-py3.8.egg

Download URL actions_includes-0.0.post78-py3.8.egg
Size 35.0 kB
Tags Egg
SHA-256 checksum
How to use checksums
0ab6994da2ecac054f51ccd7dc521c1bf0619ac5c711841af0836b5c32bc709d
BLAKE2b-256 checksum
How to use checksums
3fe402269893ce2c763cc2ef8298eccf5b4f0623fc1cd98a74e20b6b409380d6
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.post78-py3-none-any.whl

Download URL actions_includes-0.0.post78-py3-none-any.whl
Size 20.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f97aa641e04429c7fb4bdbead2d37c70b93afb4f3fd6744c8cff4464a68cc224
BLAKE2b-256 checksum
How to use checksums
6aa6679eff7b234d1c738f386bc7f11c80fefa52a69202b9c0ee0875cea270f9
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

Security for actions-includes 0.0.post78

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