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

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

Built distributions (wheels)

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

Total release size: 115.2 kB

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

Download URL actions-includes-0.0.post72.tar.gz
Size 26.5 kB
Tags Source
SHA-256 checksum
How to use checksums
277cadcb80c2a47ea174edb6f42a17a35c1ebd413627979371af4f7324efbbb5
BLAKE2b-256 checksum
How to use checksums
c90e9ae155a6844ce9530b87b783f7b7995f91fb47845626bdbc18ca047c355f
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.post72-py3.9.egg

Download URL actions_includes-0.0.post72-py3.9.egg
Size 34.1 kB
Tags Egg
SHA-256 checksum
How to use checksums
ae654fa84f7cd9726ac858ac04d1bb5b802ac9860cf305ef55f6506563508e61
BLAKE2b-256 checksum
How to use checksums
161367db9fb5b08192897a7269ce579c40fc85d7f429f84a32da16d6d64dbcef
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.post72-py3.8.egg

Download URL actions_includes-0.0.post72-py3.8.egg
Size 34.1 kB
Tags Egg
SHA-256 checksum
How to use checksums
f27345dbf4c50f09be30a93611ee18c0f1783879a6d9235a02c7233baf4ddb87
BLAKE2b-256 checksum
How to use checksums
8562351f60ba888e27abdcd028c56cc0bb24f320c90bae348ba96ff163ec074d
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.post72-py3-none-any.whl

Download URL actions_includes-0.0.post72-py3-none-any.whl
Size 20.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4506db4f259f5a2c5edba994bafda20cb3ac88595058d3cbcf4be6ff2dd14226
BLAKE2b-256 checksum
How to use checksums
780e32ea7084a59fe1ac2a09b40b96ce8f4e4079e61263a70aa4f3879bf8df60
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

Security for actions-includes 0.0.post72

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