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

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

Built distributions (wheels)

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

Total release size: 118.0 kB

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

Download URL actions-includes-0.0.post79.tar.gz
Size 26.9 kB
Tags Source
SHA-256 checksum
How to use checksums
5265fe0cb7edf294d8db65bc4f8618fbd9e61d19abda26984001935c13765dea
BLAKE2b-256 checksum
How to use checksums
41916f29de1358e3647738da5dfadb5959156fcd027759a0a34aa09cad8c4277
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.post79-py3.9.egg

Download URL actions_includes-0.0.post79-py3.9.egg
Size 35.1 kB
Tags Egg
SHA-256 checksum
How to use checksums
f8c9f7fdbc2676337b4acd8c34a2202fab479db9d13f070d84e9c1e64f22438c
BLAKE2b-256 checksum
How to use checksums
ba103c83ee1e00a30a60332a25940a23671532bd4f7c7b6884a412485d28eb2e
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.post79-py3.8.egg

Download URL actions_includes-0.0.post79-py3.8.egg
Size 35.1 kB
Tags Egg
SHA-256 checksum
How to use checksums
6304867ee89aa80aca88a15e5f17abd96a5bda3bc0c8d7052d697f21f24ad653
BLAKE2b-256 checksum
How to use checksums
88259513c120c7689a27a1294cb59ef02963b9b44662ae89de4898243f4ddbb6
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.post79-py3-none-any.whl

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

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