Skip to content

Commit ffec886

Browse files
hoverkraft-bot[bot]hoverkraft-bot[bot]
committed
docs: update actions and workflows documentation
[skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 35f7437 commit ffec886

2 files changed

Lines changed: 20 additions & 20 deletions

File tree

‎.github/workflows/docker-build-images.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -136,14 +136,14 @@ jobs:
136136
# Environment variable name(s) to pass GitHub token generated by GitHub App.
137137
# Can be a multiline string list.
138138
# This is useful to pass a generated token to the build, as it is not possible to share generated secrets between jobs.
139-
# Needs input `build-secret-github-app-id` and secret `build-secret-github-app-key`.
139+
# Needs input `build-secret-github-app-client-id` and secret `build-secret-github-app-key`.
140140
#
141141
# Default: `GITHUB_APP_TOKEN`
142142
build-secret-github-app-token-env: GITHUB_APP_TOKEN
143143

144-
# GitHub App ID to generate GitHub token to be passed as build secret env.
144+
# GitHub App client ID to generate GitHub token to be passed as build secret env.
145145
# See https://github.com/actions/create-github-app-token.
146-
build-secret-github-app-id: ""
146+
build-secret-github-app-client-id: ""
147147

148148
# The owner of the GitHub App installation.
149149
# See https://github.com/actions/create-github-app-token.
@@ -210,8 +210,8 @@ jobs:
210210
| **`build-secret-github-app-token-env`** | Environment variable name(s) to pass GitHub token generated by GitHub App. | **false** | **string** | `GITHUB_APP_TOKEN` |
211211
| | Can be a multiline string list. | | | |
212212
| | This is useful to pass a generated token to the build, as it is not possible to share generated secrets between jobs. | | | |
213-
| | Needs input `build-secret-github-app-id` and secret `build-secret-github-app-key`. | | | |
214-
| **`build-secret-github-app-id`** | GitHub App ID to generate GitHub token to be passed as build secret env. | **false** | **string** | - |
213+
| | Needs input `build-secret-github-app-client-id` and secret `build-secret-github-app-key`. | | | |
214+
| **`build-secret-github-app-client-id`** | GitHub App client ID to generate GitHub token to be passed as build secret env. | **false** | **string** | - |
215215
| | See <https://github.com/actions/create-github-app-token>. | | | |
216216
| **`build-secret-github-app-owner`** | The owner of the GitHub App installation. | **false** | **string** | `${{ github.repository_owner }}` |
217217
| | See <https://github.com/actions/create-github-app-token>. | | | |

‎actions/helm/generate-docs/README.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ Mainly using [losisin/helm-docs-github-action](https://github.com/losisin/helm-d
5353
# Default: `${{ github.token }}`
5454
github-token: ${{ github.token }}
5555

56-
# GitHub App ID to generate GitHub token in place of github-token.
56+
# GitHub App client ID to generate GitHub token in place of github-token.
5757
# See https://github.com/actions/create-github-app-token.
58-
github-app-id: ""
58+
github-app-client-id: ""
5959

6060
# GitHub App private key to generate GitHub token in place of github-token.
6161
# See https://github.com/actions/create-github-app-token.
@@ -68,19 +68,19 @@ Mainly using [losisin/helm-docs-github-action](https://github.com/losisin/helm-d
6868
6969
## Inputs
7070
71-
| **Input** | **Description** | **Required** | **Default** |
72-
| ----------------------- | ------------------------------------------------------------------------- | ------------ | ------------------------- |
73-
| **`working-directory`** | Working directory | **false** | `${{ github.workspace }}` |
74-
| **`values-file`** | Path to the values file to use for generating the documentation. | **false** | - |
75-
| | See <https://github.com/losisin/helm-values-schema-json-action>. | | |
76-
| **`github-token`** | GitHub Token to create and merge pull request. | **false** | `${{ github.token }}` |
77-
| | Permissions: | | |
78-
| | - contents: write | | |
79-
| | - pull-requests: write | | |
80-
| **`github-app-id`** | GitHub App ID to generate GitHub token in place of github-token. | **false** | - |
81-
| | See <https://github.com/actions/create-github-app-token>. | | |
82-
| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | - |
83-
| | See <https://github.com/actions/create-github-app-token>. | | |
71+
| **Input** | **Description** | **Required** | **Default** |
72+
| -------------------------- | ------------------------------------------------------------------------- | ------------ | ------------------------- |
73+
| **`working-directory`** | Working directory | **false** | `${{ github.workspace }}` |
74+
| **`values-file`** | Path to the values file to use for generating the documentation. | **false** | - |
75+
| | See <https://github.com/losisin/helm-values-schema-json-action>. | | |
76+
| **`github-token`** | GitHub Token to create and merge pull request. | **false** | `${{ github.token }}` |
77+
| | Permissions: | | |
78+
| | - contents: write | | |
79+
| | - pull-requests: write | | |
80+
| **`github-app-client-id`** | GitHub App client ID to generate GitHub token in place of github-token. | **false** | - |
81+
| | See <https://github.com/actions/create-github-app-token>. | | |
82+
| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | - |
83+
| | See <https://github.com/actions/create-github-app-token>. | | |
8484

8585
<!-- inputs:end -->
8686

0 commit comments

Comments
 (0)