Skip to content

Commit a897cc7

Browse files
docs: update actions and workflows documentation
[skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent ba3fd31 commit a897cc7

1 file changed

Lines changed: 87 additions & 1 deletion

File tree

actions/local-actions/README.md

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- header:start -->
22

3-
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItY29weSIgY29sb3I9ImJsdWUiPjxyZWN0IHg9IjkiIHk9IjkiIHdpZHRoPSIxMyIgaGVpZ2h0PSIxMyIgcng9IjIiIHJ5PSIyIj48L3JlY3Q+PHBhdGggZD0iTTUgMTVIM2EyIDIgMCAwIDEtMi0yVjNhMiAyIDAgMCAxIDItMmgxMGEyIDIgMCAwIDEgMiAydjIiPjwvcGF0aD48L3N2Zz4=) GitHub Action: Local actions
3+
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItY29weSIgY29sb3I9ImJsdWUiPjxyZWN0IHg9IjkiIHk9IjkiIHdpZHRoPSIxMyIgaGVpZ2h0PSIxMyIgcng9IjIiIHJ5PSIyIj48L3JlY3Q+PHBhdGggZD0iTTUgMTVINGEyIDIgMCAwIDEtMi0yVjRhMiAyIDAgMCAxIDItMmg5YTIgMiAwIDAgMSAyIDJ2MSI+PC9wYXRoPjwvc3ZnPg==) GitHub Action: Local actions
44

55
<div align="center">
66
<img src="../../.github/logo.svg" width="60px" align="center" alt="Local actions" />
@@ -36,3 +36,89 @@ It creates a symlink to the parent actions directory at `../self-actions` relati
3636
| **Output** | **Description** |
3737
| ---------- | ---------------------------------------------------- |
3838
| **`path`** | The resolved destination path for the copied actions |
39+
<!-- badges:start -->
40+
41+
[![Marketplace](https://img.shields.io/badge/Marketplace-local--actions-blue?logo=github-actions)](https://github.com/marketplace/actions/local-actions)
42+
[![Release](https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-common)](https://github.com/hoverkraft-tech/ci-github-common/releases)
43+
[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-common)](http://choosealicense.com/licenses/mit/)
44+
[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-common?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-common?style=social)
45+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md)
46+
47+
<!-- badges:end -->
48+
<!-- overview:start -->
49+
50+
## Overview
51+
52+
Action to expose sibling local actions next to the current action directory.
53+
It copies the parent actions directory into a configurable destination and cleans it up automatically in the post action.
54+
55+
FIXME: This is a workaround until this issue is resolved: <https://github.com/actions/runner/issues/1348>.
56+
57+
<!-- overview:end -->
58+
<!-- usage:start -->
59+
60+
## Usage
61+
62+
```yaml
63+
- uses: hoverkraft-tech/ci-github-common/actions/local-actions@4b53189212d5810f710bed89711002626977215b # 0.33.0
64+
with:
65+
# The actions root path that contains the sibling local actions.
66+
# Pass the caller actions root, typically by appending `/../..` to `github.action_path`.
67+
#
68+
# This input is required.
69+
source-path: ""
70+
```
71+
72+
<!-- usage:end -->
73+
<!-- inputs:start -->
74+
75+
## Inputs
76+
77+
| **Input** | **Description** | **Required** | **Default** |
78+
| ----------------- | -------------------------------------------------------------------------------------- | ------------ | ----------- |
79+
| **`source-path`** | The actions root path that contains the sibling local actions. | **true** | - |
80+
| | Pass the caller actions root, typically by appending `/../..` to `github.action_path`. | | |
81+
82+
<!-- inputs:end -->
83+
<!-- secrets:start -->
84+
<!-- secrets:end -->
85+
<!-- outputs:start -->
86+
87+
## Outputs
88+
89+
| **Output** | **Description** |
90+
| ---------- | ----------------------------------------------------------- |
91+
| **`path`** | The resolved destination path for the copied local actions. |
92+
93+
<!-- outputs:end -->
94+
<!-- examples:start -->
95+
<!-- examples:end -->
96+
<!-- contributing:start -->
97+
98+
## Contributing
99+
100+
Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md) for more details.
101+
102+
<!-- contributing:end -->
103+
<!-- security:start -->
104+
<!-- security:end -->
105+
<!-- license:start -->
106+
107+
## License
108+
109+
This project is licensed under the MIT License.
110+
111+
SPDX-License-Identifier: MIT
112+
113+
Copyright © 2026 hoverkraft
114+
115+
For more details, see the [license](http://choosealicense.com/licenses/mit/).
116+
117+
<!-- license:end -->
118+
<!-- generated:start -->
119+
120+
---
121+
122+
This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
123+
124+
<!-- generated:end -->

0 commit comments

Comments
 (0)