Skip to content

Commit 1613dbb

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 93916b4 commit 1613dbb

1 file changed

Lines changed: 12 additions & 4 deletions

File tree

actions/local-workflow-actions/README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,12 @@ Example: if `actions-path` is `.github/actions`, then local actions will be avai
4444
#
4545
# Default: `.github/actions`
4646
actions-path: .github/actions
47+
48+
# A GitHub token with permissions to checkout the reusable workflow repository.
49+
# This is required when the repository is private. For public repositories, this can be left empty and the checkout will be attempted anonymously.
50+
#
51+
# Default: `${{ github.token }}`
52+
github-token: ${{ github.token }}
4753
```
4854
4955
<!-- usage:end -->
@@ -52,10 +58,12 @@ Example: if `actions-path` is `.github/actions`, then local actions will be avai
5258
5359
## Inputs
5460
55-
| **Input** | **Description** | **Required** | **Default** |
56-
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------------- |
57-
| **`actions-path`** | Relative path(s) (inside the workflow repository) containing the local actions to expose in the current workspace. | **false** | `.github/actions` |
58-
| | The same relative path will be available under `../self-workflow` relative to `github.workspace` (for example `../self-workflow/.github/actions`). | | |
61+
| **Input** | **Description** | **Required** | **Default** |
62+
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- |
63+
| **`actions-path`** | Relative path(s) (inside the workflow repository) containing the local actions to expose in the current workspace. | **false** | `.github/actions` |
64+
| | The same relative path will be available under `../self-workflow` relative to `github.workspace` (for example `../self-workflow/.github/actions`). | | |
65+
| **`github-token`** | A GitHub token with permissions to checkout the reusable workflow repository. | **false** | `${{ github.token }}` |
66+
| | This is required when the repository is private. For public repositories, this can be left empty and the checkout will be attempted anonymously. | | |
5967

6068
<!-- inputs:end -->
6169

0 commit comments

Comments
 (0)