Skip to content

Commit ff81510

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 2d44fec commit ff81510

1 file changed

Lines changed: 17 additions & 11 deletions

File tree

actions/checkout/README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ permissions:
4343
## Usage
4444
4545
```yaml
46-
- uses: hoverkraft-tech/ci-github-common/actions/checkout@71b85947453f32b5d147ff3ab37351439a92d840 # 0.34.2
46+
- uses: hoverkraft-tech/ci-github-common/actions/checkout@b48521243b3ce4824d46bf414c32d8078171b48b # 0.35.1
4747
with:
4848
# Number of commits to fetch. 0 indicates all history for all branches and tags.
4949
# See https://github.com/actions/checkout#usage
@@ -57,6 +57,10 @@ permissions:
5757
# Default: `false`
5858
lfs: "false"
5959

60+
# Whether to enable sparse checkout and the list of files or directories to include in the checkout.
61+
# See https://github.com/actions/checkout#usage
62+
sparse-checkout: ""
63+
6064
# Whether to persist the token credentials in the Git config.
6165
# Default to false for security reasons.
6266
# See https://github.com/orgs/community/discussions/179107.
@@ -74,16 +78,18 @@ permissions:
7478
7579
## Inputs
7680
77-
| **Input** | **Description** | **Required** | **Default** |
78-
| ------------------------- | --------------------------------------------------------------------------------- | ------------ | ----------- |
79-
| **`fetch-depth`** | Number of commits to fetch. 0 indicates all history for all branches and tags. | **false** | `1` |
80-
| | See <https://github.com/actions/checkout#usage> | | |
81-
| **`lfs`** | Whether to download Git-LFS files. | **false** | `false` |
82-
| | See <https://github.com/actions/checkout#usage> | | |
83-
| **`persist-credentials`** | Whether to persist the token credentials in the Git config. | **false** | `false` |
84-
| | Default to false for security reasons. | | |
85-
| | See <https://github.com/orgs/community/discussions/179107>. | | |
86-
| **`token`** | Token to use for checking out the repository instead of the default GITHUB_TOKEN. | **false** | - |
81+
| **Input** | **Description** | **Required** | **Default** |
82+
| ------------------------- | -------------------------------------------------------------------------------------------------- | ------------ | ----------- |
83+
| **`fetch-depth`** | Number of commits to fetch. 0 indicates all history for all branches and tags. | **false** | `1` |
84+
| | See <https://github.com/actions/checkout#usage> | | |
85+
| **`lfs`** | Whether to download Git-LFS files. | **false** | `false` |
86+
| | See <https://github.com/actions/checkout#usage> | | |
87+
| **`sparse-checkout`** | Whether to enable sparse checkout and the list of files or directories to include in the checkout. | **false** | - |
88+
| | See <https://github.com/actions/checkout#usage> | | |
89+
| **`persist-credentials`** | Whether to persist the token credentials in the Git config. | **false** | `false` |
90+
| | Default to false for security reasons. | | |
91+
| | See <https://github.com/orgs/community/discussions/179107>. | | |
92+
| **`token`** | Token to use for checking out the repository instead of the default GITHUB_TOKEN. | **false** | - |
8793

8894
<!-- inputs:end -->
8995

0 commit comments

Comments
 (0)