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

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

Built distributions (wheels)

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

Total release size: 110.8 kB

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

Download URL actions-includes-0.0.post67.tar.gz
Size 25.8 kB
Tags Source
SHA-256 checksum
How to use checksums
4168d90394af7acd195fa5d50747872cb4296e2e2d6f1264f4c4913a411c080b
BLAKE2b-256 checksum
How to use checksums
3ba39972f2134caa2589f1a7c91032426bf9fdd8c5ae62ff9c29373e6862682d
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.post67-py3.9.egg

Download URL actions_includes-0.0.post67-py3.9.egg
Size 32.6 kB
Tags Egg
SHA-256 checksum
How to use checksums
c08b6a54e2646c18f1612174fb1d7fb929ec82c61fcfcffcec3760eab4d0a055
BLAKE2b-256 checksum
How to use checksums
60640782c6ad93e32c277dd8e510429b4f157c7ada901efa514a9f1b8e7944ea
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.post67-py3.8.egg

Download URL actions_includes-0.0.post67-py3.8.egg
Size 32.6 kB
Tags Egg
SHA-256 checksum
How to use checksums
ad284b47705cb82b75a2f8fc96a90a7bd5138f31a3004b626d116ff017533ef5
BLAKE2b-256 checksum
How to use checksums
9607e21245ccfe5b880f46cb91618e4ede0eb727d8ede9b6937d1ede8bb26ced
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.post67-py3-none-any.whl

Download URL actions_includes-0.0.post67-py3-none-any.whl
Size 19.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9e186d460b3979516bfd1e52a852e5fce4514ce1ada56b97156745eda6a94dc1
BLAKE2b-256 checksum
How to use checksums
ed91517685dafef959d068dc1057fc1cecaea3496391bec02237a004baf2e00b
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.post67

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