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

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

Built distributions (wheels)

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

Total release size: 70.9 kB

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

Download URL actions-includes-0.0.post60.tar.gz
Size 20.0 kB
Tags Source
SHA-256 checksum
How to use checksums
af9d8c2a9b0696adc26be8d8deed22cc792f6f54dd1f7a8ca772395aa7142e80
BLAKE2b-256 checksum
How to use checksums
095b6bc85b166328dd247ceb7da899ebb385f5d7fba9a4f3aac558f1bb2c2a84
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.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

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

Download URL actions_includes-0.0.post60-py3.9.egg
Size 18.4 kB
Tags Egg
SHA-256 checksum
How to use checksums
9b0c5fb5d980bf5e8affb3121d1184ed688d97c6bd8f80f24052da4c0d5d9763
BLAKE2b-256 checksum
How to use checksums
48717e8b2396c85553c162a0e2f34133739c129b73d835aac196ea810c9b841c
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.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.1

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

Download URL actions_includes-0.0.post60-py3.8.egg
Size 18.4 kB
Tags Egg
SHA-256 checksum
How to use checksums
75193f7ae551533ea00e941403045a95b3c13378468b4d167f80f27fb791726f
BLAKE2b-256 checksum
How to use checksums
76fe24933de4a4aef7901de96e41d4be1a7d4301ba6549affeadbad12012cef9
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.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

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

Download URL actions_includes-0.0.post60-py3-none-any.whl
Size 14.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1f997fe274c1203fd62807a7c6180d2489db6ae02a017429d44cf47ff4726598
BLAKE2b-256 checksum
How to use checksums
cedf7954b49412a11050160cbe11753bbb0d54e612e0029393032144df1184c1
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.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

Security for actions-includes 0.0.post60

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