Skip to content

docs: update actions and workflows documentation #745

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hoverkraft-bot merged 1 commit into from
Apr 27, 2026
Merged

docs: update actions and workflows documentation #745

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/workflows/docker-build-images.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,14 +136,14 @@ jobs:
# Environment variable name(s) to pass GitHub token generated by GitHub App.
# Can be a multiline string list.
# This is useful to pass a generated token to the build, as it is not possible to share generated secrets between jobs.
# Needs input `build-secret-github-app-id` and secret `build-secret-github-app-key`.
# Needs input `build-secret-github-app-client-id` and secret `build-secret-github-app-key`.
#
# Default: `GITHUB_APP_TOKEN`
build-secret-github-app-token-env: GITHUB_APP_TOKEN

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

# The owner of the GitHub App installation.
# See https://github.com/actions/create-github-app-token.
Expand Down Expand Up @@ -210,8 +210,8 @@ jobs:
| **`build-secret-github-app-token-env`** | Environment variable name(s) to pass GitHub token generated by GitHub App. | **false** | **string** | `GITHUB_APP_TOKEN` |
| | Can be a multiline string list. | | | |
| | This is useful to pass a generated token to the build, as it is not possible to share generated secrets between jobs. | | | |
| | Needs input `build-secret-github-app-id` and secret `build-secret-github-app-key`. | | | |
| **`build-secret-github-app-id`** | GitHub App ID to generate GitHub token to be passed as build secret env. | **false** | **string** | - |
| | Needs input `build-secret-github-app-client-id` and secret `build-secret-github-app-key`. | | | |
| **`build-secret-github-app-client-id`** | GitHub App client ID to generate GitHub token to be passed as build secret env. | **false** | **string** | - |
| | See <https://github.com/actions/create-github-app-token>. | | | |
| **`build-secret-github-app-owner`** | The owner of the GitHub App installation. | **false** | **string** | `${{ github.repository_owner }}` |
| | See <https://github.com/actions/create-github-app-token>. | | | |
Expand Down
30 changes: 15 additions & 15 deletions actions/helm/generate-docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ Mainly using [losisin/helm-docs-github-action](https://github.com/losisin/helm-d
# Default: `${{ github.token }}`
github-token: ${{ github.token }}

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

# GitHub App private key to generate GitHub token in place of github-token.
# See https://github.com/actions/create-github-app-token.
Expand All @@ -68,19 +68,19 @@ Mainly using [losisin/helm-docs-github-action](https://github.com/losisin/helm-d

## Inputs

| **Input** | **Description** | **Required** | **Default** |
| ----------------------- | ------------------------------------------------------------------------- | ------------ | ------------------------- |
| **`working-directory`** | Working directory | **false** | `${{ github.workspace }}` |
| **`values-file`** | Path to the values file to use for generating the documentation. | **false** | - |
| | See <https://github.com/losisin/helm-values-schema-json-action>. | | |
| **`github-token`** | GitHub Token to create and merge pull request. | **false** | `${{ github.token }}` |
| | Permissions: | | |
| | - contents: write | | |
| | - pull-requests: write | | |
| **`github-app-id`** | GitHub App ID to generate GitHub token in place of github-token. | **false** | - |
| | See <https://github.com/actions/create-github-app-token>. | | |
| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | - |
| | See <https://github.com/actions/create-github-app-token>. | | |
| **Input** | **Description** | **Required** | **Default** |
| -------------------------- | ------------------------------------------------------------------------- | ------------ | ------------------------- |
| **`working-directory`** | Working directory | **false** | `${{ github.workspace }}` |
| **`values-file`** | Path to the values file to use for generating the documentation. | **false** | - |
| | See <https://github.com/losisin/helm-values-schema-json-action>. | | |
| **`github-token`** | GitHub Token to create and merge pull request. | **false** | `${{ github.token }}` |
| | Permissions: | | |
| | - contents: write | | |
| | - pull-requests: write | | |
| **`github-app-client-id`** | GitHub App client ID to generate GitHub token in place of github-token. | **false** | - |
| | See <https://github.com/actions/create-github-app-token>. | | |
| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | - |
| | See <https://github.com/actions/create-github-app-token>. | | |

<!-- inputs:end -->

Expand Down