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

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

Built distributions (wheels)

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

Total release size: 103.4 kB

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

Download URL actions-includes-0.0.post66.tar.gz
Size 24.9 kB
Tags Source
SHA-256 checksum
How to use checksums
52a875870964582a4c4d0869a245cfdee050891429d55e67b0f8c9e0545cbb47
BLAKE2b-256 checksum
How to use checksums
016429a7cb59300d90b65fa35e8b31598457c64df996308e44d8ef3ee29cb628
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.58.0 CPython/3.9.2

Release files / actions_includes-0.0.post66-py3.9.egg

Download URL actions_includes-0.0.post66-py3.9.egg
Size 29.7 kB
Tags Egg
SHA-256 checksum
How to use checksums
ef1ab1bab932a54e6a2f87caa14ec2ff4eaf68413491e5a7b62eb81f4397a039
BLAKE2b-256 checksum
How to use checksums
3b3de6bda24d426a0e633b274803ffa92fb419644997530f373bf3421163d572
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.58.0 CPython/3.9.2

Release files / actions_includes-0.0.post66-py3.8.egg

Download URL actions_includes-0.0.post66-py3.8.egg
Size 29.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
9b0288811ea841035129d9d2cd7cdfe7c444378949f99401040a34318208bd28
BLAKE2b-256 checksum
How to use checksums
b74751115e0a5e9c1033143ab27af6db0ed860d4e2e330d9bc87c173cdf23bf8
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.58.0 CPython/3.8.8

Release files / actions_includes-0.0.post66-py3-none-any.whl

Download URL actions_includes-0.0.post66-py3-none-any.whl
Size 18.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e6f5d2ec937ee3962050343389e13c34b0d834a6bb1316a178482eb3e92e3278
BLAKE2b-256 checksum
How to use checksums
7aa97334e6f33d47d97b7ed95127f42bb010e43389286a597d85c7a366c5fe5d
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.58.0 CPython/3.9.2

Security for actions-includes 0.0.post66

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