diff --git a/actions/working-directory/README.md b/actions/working-directory/README.md index b92bcaf..dbba18e 100644 --- a/actions/working-directory/README.md +++ b/actions/working-directory/README.md @@ -1,9 +1,9 @@ -# GitHub Action: Resolve working directory +# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItZm9sZGVyIiBjb2xvcj0iYmx1ZSI+PHBhdGggZD0iTTIyIDE5YTIgMiAwIDAgMS0yIDJINGEyIDIgMCAwIDEtMi0yVjVhMiAyIDAgMCAxIDItMmg1bDIgM2g5YTIgMiAwIDAgMSAyIDJ6Ij48L3BhdGg+PC9zdmc+) GitHub Action: Working directory
- Resolve working directory + Working directory
--- @@ -51,3 +51,83 @@ jobs: - name: Show resolved directory run: echo "${{ steps.resolve-working-directory.outputs.working-directory }}" ``` + + +[![Marketplace](https://img.shields.io/badge/Marketplace-working--directory-blue?logo=github-actions)](https://github.com/marketplace/actions/working-directory) +[![Release](https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-common)](https://github.com/hoverkraft-tech/ci-github-common/releases) +[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-common)](http://choosealicense.com/licenses/mit/) +[![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) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md) + + + + +## Overview + +Action to resolve and validate a working directory path. + + + + +## Usage + +```yaml +- uses: hoverkraft-tech/ci-github-common/actions/working-directory@f24ce3360a8abf9bf386a62ab13d0ae5de5f9d13 # 0.31.7 + with: + # Relative or absolute working directory path to resolve. + # Default: `.` + working-directory: . +``` + + + + +## Inputs + +| **Input** | **Description** | **Required** | **Default** | +| ----------------------- | ------------------------------------------------------- | ------------ | ----------- | +| **`working-directory`** | Relative or absolute working directory path to resolve. | **false** | `.` | + + + + + + +## Outputs + +| **Output** | **Description** | +| ----------------------- | --------------------------------------------- | +| **`working-directory`** | The resolved absolute working directory path. | + + + + + + +## Contributing + +Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md) for more details. + + + + + + +## License + +This project is licensed under the MIT License. + +SPDX-License-Identifier: MIT + +Copyright © 2026 hoverkraft + +For more details, see the [license](http://choosealicense.com/licenses/mit/). + + + + +--- + +This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor). + +