Skip to content

Commit 4bfbc05

Browse files
committed
docs(actions): update doc for working-directory action
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
1 parent 790306a commit 4bfbc05

1 file changed

Lines changed: 1 addition & 43 deletions

File tree

actions/working-directory/README.md

Lines changed: 1 addition & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -9,48 +9,6 @@
99
---
1010

1111
<!-- header:end -->
12-
13-
## Overview
14-
15-
Action to resolve and validate a working directory path.
16-
17-
## Usage
18-
19-
```yaml
20-
- id: resolve-working-directory
21-
uses: hoverkraft-tech/ci-github-common/actions/resolve-working-directory@<sha>
22-
with:
23-
working-directory: .
24-
```
25-
26-
## Inputs
27-
28-
| **Input** | **Description** | **Required** | **Default** |
29-
| ----------------------- | ------------------------------------------------------- | ------------ | ----------- |
30-
| **`working-directory`** | Relative or absolute working directory path to resolve. | No | `.` |
31-
32-
## Outputs
33-
34-
| **Output** | **Description** |
35-
| ----------------------- | --------------------------------------------- |
36-
| **`working-directory`** | The resolved absolute working directory path. |
37-
38-
## Example
39-
40-
```yaml
41-
jobs:
42-
example:
43-
runs-on: ubuntu-latest
44-
steps:
45-
- uses: actions/checkout@v4
46-
- id: resolve-working-directory
47-
uses: hoverkraft-tech/ci-github-common/actions/resolve-working-directory@<sha>
48-
with:
49-
working-directory: actions/parse-ci-reports
50-
51-
- name: Show resolved directory
52-
run: echo "${{ steps.resolve-working-directory.outputs.working-directory }}"
53-
```
5412
<!-- badges:start -->
5513

5614
[![Marketplace](https://img.shields.io/badge/Marketplace-working--directory-blue?logo=github-actions)](https://github.com/marketplace/actions/working-directory)
@@ -72,7 +30,7 @@ Action to resolve and validate a working directory path.
7230
## Usage
7331

7432
```yaml
75-
- uses: hoverkraft-tech/ci-github-common/actions/working-directory@f24ce3360a8abf9bf386a62ab13d0ae5de5f9d13 # 0.31.7
33+
- uses: hoverkraft-tech/ci-github-common/actions/working-directory@790306a64b804be99e388ca20b780fd3afa9295f # main
7634
with:
7735
# Relative or absolute working directory path to resolve.
7836
# Default: `.`

0 commit comments

Comments
 (0)