From c0cf8a935bcb5d0800f02b8b79c3ab03c1135a2a Mon Sep 17 00:00:00 2001 From: "hoverkraft-bot[bot]" <128996893+hoverkraft-bot[bot]@users.noreply.github.com> Date: Thu, 21 May 2026 17:58:57 +0000 Subject: [PATCH] docs: update actions and workflows documentation [skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- actions/helm/generate-docs/README.md | 36 +++++++++++++++------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/actions/helm/generate-docs/README.md b/actions/helm/generate-docs/README.md index d1c855c9..6c4ae11f 100644 --- a/actions/helm/generate-docs/README.md +++ b/actions/helm/generate-docs/README.md @@ -35,15 +35,16 @@ Mainly using [losisin/helm-docs-github-action](https://github.com/losisin/helm-d ## Usage ```yaml -- uses: hoverkraft-tech/ci-github-container/actions/helm/generate-docs@676925b78f1970281b3f087bc3829eb1c6a9f4dc # 0.34.1 +- uses: hoverkraft-tech/ci-github-container/actions/helm/generate-docs@260358ba1fd405c57bc669823d89c625971a3431 # 0.34.2 with: # Working directory # Default: `${{ github.workspace }}` working-directory: ${{ github.workspace }} - # The git ref to checkout before generating documentation. + # The Git ref to checkout before generating documentation. # Can be a branch, tag or commit SHA. # Set to an empty string to skip checkout. + # # Default: `${{ github.ref }}` checkout-ref: ${{ github.ref }} @@ -74,21 +75,22 @@ 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 }}` | -| **`checkout-ref`** | The Git ref to checkout before generating documentation. | **false** | `${{ github.ref }}` | -| | Can be a branch, tag or commit SHA. Set to an empty string to skip checkout. | | | -| **`values-file`** | Path to the values file to use for generating the documentation. | **false** | - | -| | See . | | | -| **`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 . | | | -| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | - | -| | See . | | | +| **Input** | **Description** | **Required** | **Default** | +| -------------------------- | ------------------------------------------------------------------------- | ------------ | ------------------------- | +| **`working-directory`** | Working directory | **false** | `${{ github.workspace }}` | +| **`checkout-ref`** | The Git ref to checkout before generating documentation. | **false** | `${{ github.ref }}` | +| | Can be a branch, tag or commit SHA. | | | +| | Set to an empty string to skip checkout. | | | +| **`values-file`** | Path to the values file to use for generating the documentation. | **false** | - | +| | See . | | | +| **`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 . | | | +| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | - | +| | See . | | |