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

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

Built distributions (wheels)

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

Total release size: 117.0 kB

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

Download URL actions-includes-0.0.post75.tar.gz
Size 26.8 kB
Tags Source
SHA-256 checksum
How to use checksums
1c31aafad302bdd36e1bbbb2a4183980f5de3cb44d66639d871988ee4b731c36
BLAKE2b-256 checksum
How to use checksums
2a91f2d5a0794fdc4630ee7d43b2223463153e1ab1830d4e1f72ef1a25df407b
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.post75-py3.9.egg

Download URL actions_includes-0.0.post75-py3.9.egg
Size 34.7 kB
Tags Egg
SHA-256 checksum
How to use checksums
05004bb4a740afc7e61c71fed3154f8359cfd8c5fd51f13accefb25beb6406ea
BLAKE2b-256 checksum
How to use checksums
989d96d7f4fbed1e34829a5e8d334c84800d204ebcec50d8209811621edb06ce
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.post75-py3.8.egg

Download URL actions_includes-0.0.post75-py3.8.egg
Size 34.7 kB
Tags Egg
SHA-256 checksum
How to use checksums
099aface6253cf47760128baf5274c0615f3e5be5fb0965a0510ee7636fbb6db
BLAKE2b-256 checksum
How to use checksums
e6dcf03e10892bc73e27cffe62736ea4a5ae9a814ee793d54f926b71faaba4c0
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.post75-py3-none-any.whl

Download URL actions_includes-0.0.post75-py3-none-any.whl
Size 20.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0037bc5238addf818551304709f01f7191a91373fb8dd3bdbbf66797ddff59df
BLAKE2b-256 checksum
How to use checksums
1e6b57da545fb7d0425b3af7bd538aad7de58f5063a4671382c0f30fc8b84759
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.post75

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