Skip to content

Commit e58614f

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

1 file changed

Lines changed: 82 additions & 2 deletions

File tree

‎actions/working-directory/README.md‎

Lines changed: 82 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<!-- header:start -->
22

3-
# GitHub Action: Resolve working directory
3+
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItZm9sZGVyIiBjb2xvcj0iYmx1ZSI+PHBhdGggZD0iTTIyIDE5YTIgMiAwIDAgMS0yIDJINGEyIDIgMCAwIDEtMi0yVjVhMiAyIDAgMCAxIDItMmg1bDIgM2g5YTIgMiAwIDAgMSAyIDJ6Ij48L3BhdGg+PC9zdmc+) GitHub Action: Working directory
44

55
<div align="center">
6-
<img src="../../.github/logo.svg" width="60px" align="center" alt="Resolve working directory" />
6+
<img src="../../.github/logo.svg" width="60px" align="center" alt="Working directory" />
77
</div>
88

99
---
@@ -51,3 +51,83 @@ jobs:
5151
- name: Show resolved directory
5252
run: echo "${{ steps.resolve-working-directory.outputs.working-directory }}"
5353
```
54+
<!-- badges:start -->
55+
56+
[![Marketplace](https://img.shields.io/badge/Marketplace-working--directory-blue?logo=github-actions)](https://github.com/marketplace/actions/working-directory)
57+
[![Release](https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-common)](https://github.com/hoverkraft-tech/ci-github-common/releases)
58+
[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-common)](http://choosealicense.com/licenses/mit/)
59+
[![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)
60+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md)
61+
62+
<!-- badges:end -->
63+
<!-- overview:start -->
64+
65+
## Overview
66+
67+
Action to resolve and validate a working directory path.
68+
69+
<!-- overview:end -->
70+
<!-- usage:start -->
71+
72+
## Usage
73+
74+
```yaml
75+
- uses: hoverkraft-tech/ci-github-common/actions/working-directory@f24ce3360a8abf9bf386a62ab13d0ae5de5f9d13 # 0.31.7
76+
with:
77+
# Relative or absolute working directory path to resolve.
78+
# Default: `.`
79+
working-directory: .
80+
```
81+
82+
<!-- usage:end -->
83+
<!-- inputs:start -->
84+
85+
## Inputs
86+
87+
| **Input** | **Description** | **Required** | **Default** |
88+
| ----------------------- | ------------------------------------------------------- | ------------ | ----------- |
89+
| **`working-directory`** | Relative or absolute working directory path to resolve. | **false** | `.` |
90+
91+
<!-- inputs:end -->
92+
<!-- secrets:start -->
93+
<!-- secrets:end -->
94+
<!-- outputs:start -->
95+
96+
## Outputs
97+
98+
| **Output** | **Description** |
99+
| ----------------------- | --------------------------------------------- |
100+
| **`working-directory`** | The resolved absolute working directory path. |
101+
102+
<!-- outputs:end -->
103+
<!-- examples:start -->
104+
<!-- examples:end -->
105+
<!-- contributing:start -->
106+
107+
## Contributing
108+
109+
Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md) for more details.
110+
111+
<!-- contributing:end -->
112+
<!-- security:start -->
113+
<!-- security:end -->
114+
<!-- license:start -->
115+
116+
## License
117+
118+
This project is licensed under the MIT License.
119+
120+
SPDX-License-Identifier: MIT
121+
122+
Copyright © 2026 hoverkraft
123+
124+
For more details, see the [license](http://choosealicense.com/licenses/mit/).
125+
126+
<!-- license:end -->
127+
<!-- generated:start -->
128+
129+
---
130+
131+
This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
132+
133+
<!-- generated:end -->

0 commit comments

Comments
 (0)