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

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

Built distributions (wheels)

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

Total release size: 116.4 kB

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

Download URL actions-includes-0.0.post74.tar.gz
Size 26.6 kB
Tags Source
SHA-256 checksum
How to use checksums
de77306c816aca6073a578d8202645b7e44ba5efe2d7cabb835b0256c2f8ee1c
BLAKE2b-256 checksum
How to use checksums
a17bde53c88513b78c412ed5b151aeb9aeb18c0bc9ae71a5bea9667edea57c2e
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.post74-py3.9.egg

Download URL actions_includes-0.0.post74-py3.9.egg
Size 34.5 kB
Tags Egg
SHA-256 checksum
How to use checksums
dfa83f937aa187554c99a95cb3176f7493def47b974ce770f0aab74237df17a1
BLAKE2b-256 checksum
How to use checksums
6e706e9a7c17c1705a5a5cdea6ecd013e3b38f33628414a779db3464cb469f72
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.post74-py3.8.egg

Download URL actions_includes-0.0.post74-py3.8.egg
Size 34.5 kB
Tags Egg
SHA-256 checksum
How to use checksums
a1ad5cf84709953234b7792c7b1fbaafa4d39c611f97133f6df49fe9ff5344e5
BLAKE2b-256 checksum
How to use checksums
c9dcbbadd61c15458e35cb440e02b98b05e5d237e3983e0bc082c03d4186b30d
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.post74-py3-none-any.whl

Download URL actions_includes-0.0.post74-py3-none-any.whl
Size 20.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
13e64f799fea27ce983dbcf481894485a1d06b8edd29a4fda9b3b61dc6b3a74e
BLAKE2b-256 checksum
How to use checksums
8c4dfbe831d7e7509bbd4961024644a9b47041f582594cdcb9aac46b378da2c6
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.post74

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