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 ingithub.com/{owner}/{repo}{owner}/{repo}/{path}@{ref}- Public action under{path}ingithub.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
55 Dec 5, 2022
19 Dec 10, 2022
12 Nov 3, 2022
3 Nov 30, 2021
555 Dec 24, 2022
1 Nov 9, 2021
20 Oct 31, 2022
1.6k Jan 6, 2023
419 Jan 3, 2023
1 Jan 9, 2023
7 Oct 27, 2022
50 Jan 7, 2023
3 Mar 11, 2022
7 Aug 15, 2022
5 Mar 14, 2022
171 Dec 26, 2022
67 Jan 3, 2023
27 Jul 20, 2022
20 Jan 3, 2023