Skip to content

Commit 62ef6cd

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 d8e8b63 commit 62ef6cd

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

actions/checkout/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ permissions:
3636
<!-- start usage -->
3737
3838
```yaml
39-
- uses: hoverkraft-tech/ci-github-common@0.18.0
39+
- uses: hoverkraft-tech/ci-github-common@0.19.0
4040
with:
4141
# Description: Number of commits to fetch. 0 indicates all history for all
4242
# branches and tags. See
@@ -61,11 +61,11 @@ permissions:
6161
<!-- end usage -->
6262
<!-- start inputs -->
6363
64-
| **Input** | **Description** | **Default** | **Required** |
65-
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------------ |
66-
| <code>fetch-depth</code> | Number of commits to fetch. 0 indicates all history for all branches and tags. See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | <code>1</code> | **false** |
67-
| <code>lfs</code> | Whether to download Git-LFS files. See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | | **false** |
68-
| <code>token</code> | Token to use for checking out the repository instead of the default GITHUB_TOKEN.<br />If specified and not empty, persist-credentials in checkout will be false. | | **false** |
64+
| **Input** | **Description** | **Default** | **Required** |
65+
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------------ |
66+
| <code>fetch-depth</code> | Number of commits to fetch. 0 indicates all history for all branches and tags. See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | <code>1</code> | **false** |
67+
| <code>lfs</code> | Whether to download Git-LFS files. See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | <code>false</code> | **false** |
68+
| <code>token</code> | Token to use for checking out the repository instead of the default GITHUB_TOKEN.<br />If specified and not empty, persist-credentials in checkout will be false. | | **false** |
6969
7070
<!-- end inputs -->
7171
<!-- start outputs -->

actions/create-and-merge-pull-request/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ See [Allow GitHub Actions to create and approve pull requests](https://docs.gith
2929
<!-- start usage -->
3030

3131
```yaml
32-
- uses: hoverkraft-tech/ci-github-common@0.18.0
32+
- uses: hoverkraft-tech/ci-github-common@0.19.0
3333
with:
3434
# Description: GitHub token for creating and merging pull request (permissions
3535
# contents: write and pull-requests: write). See
36-
# https://github.com/peter-evans/create-pull-request#action-inputs.
36+
# <https://github.com/peter-evans/create-pull-request#action-inputs>.
3737
#
3838
# Default: ${{ github.token }}
3939
github-token: ""
@@ -61,13 +61,13 @@ See [Allow GitHub Actions to create and approve pull requests](https://docs.gith
6161
6262
<!-- start inputs -->
6363
64-
| **Input** | **Description** | **Default** | **Required** |
65-
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------ |
66-
| <code>github-token</code> | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write). See <https://github.com/peter-evans/create-pull-request#action-inputs>. | <code>${{ github.token }}</code> | **false** |
67-
| <code>branch</code> | The pull request branch name | | **true** |
68-
| <code>title</code> | The pull request title | | **true** |
69-
| <code>body</code> | The pull request body | | **true** |
70-
| <code>commit-message</code> | The commit message for the pull request | | **true** |
64+
| **Input** | **Description** | **Default** | **Required** |
65+
| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------ |
66+
| <code>github-token</code> | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write).<br />See <https://github.com/peter-evans/create-pull-request#action-inputs>. | <code>${{ github.token }}</code> | **false** |
67+
| <code>branch</code> | The pull request branch name | | **true** |
68+
| <code>title</code> | The pull request title | | **true** |
69+
| <code>body</code> | The pull request body | | **true** |
70+
| <code>commit-message</code> | The commit message for the pull request | | **true** |
7171
7272
<!-- end inputs -->
7373
<!-- start outputs -->

0 commit comments

Comments
 (0)