Skip to content

Commit f5847cb

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 b44eec6 commit f5847cb

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

actions/working-directory/README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,21 @@ Action to resolve and validate a working directory path.
3535
# Relative or absolute working directory path to resolve.
3636
# Default: `.`
3737
working-directory: .
38+
39+
# Whether to fail when the resolved path is outside GITHUB_WORKSPACE.
40+
# Default: `true`
41+
enforce-path-in-workspace: "true"
3842
```
3943
4044
<!-- usage:end -->
4145
<!-- inputs:start -->
4246
4347
## Inputs
4448
45-
| **Input** | **Description** | **Required** | **Default** |
46-
| ------------------------------- | --------------------------------------------------------------------- | ------------ | ----------- |
47-
| **`working-directory`** | Relative or absolute working directory path to resolve. | **false** | `.` |
48-
| **`enforce-path-in-workspace`** | Whether to fail when the resolved path is outside `GITHUB_WORKSPACE`. | **false** | `true` |
49+
| **Input** | **Description** | **Required** | **Default** |
50+
| ------------------------------- | ------------------------------------------------------------------- | ------------ | ----------- |
51+
| **`working-directory`** | Relative or absolute working directory path to resolve. | **false** | `.` |
52+
| **`enforce-path-in-workspace`** | Whether to fail when the resolved path is outside GITHUB_WORKSPACE. | **false** | `true` |
4953

5054
<!-- inputs:end -->
5155
<!-- secrets:start -->
@@ -54,10 +58,10 @@ Action to resolve and validate a working directory path.
5458

5559
## Outputs
5660

57-
| **Output** | **Description** |
58-
| ----------------------------- | ------------------------------------------------------------------- |
59-
| **`absolute-path`** | The resolved absolute working directory path. |
60-
| **`workspace-relative-path`** | The resolved working directory path relative to `GITHUB_WORKSPACE`. |
61+
| **Output** | **Description** |
62+
| ----------------------------- | ----------------------------------------------------------------- |
63+
| **`absolute-path`** | The resolved absolute working directory path. |
64+
| **`workspace-relative-path`** | The resolved working directory path relative to GITHUB_WORKSPACE. |
6165

6266
<!-- outputs:end -->
6367
<!-- examples:start -->

0 commit comments

Comments
 (0)