Skip to content

feat(actions/helm/generate-docs): add checkout-ref input to skip Git checkout #787

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
neilime merged 1 commit into from
May 21, 2026
Merged

feat(actions/helm/generate-docs): add checkout-ref input to skip Git checkout #787

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
34 changes: 21 additions & 13 deletions actions/helm/generate-docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ Mainly using [losisin/helm-docs-github-action](https://github.com/losisin/helm-d
# Default: `${{ github.workspace }}`
working-directory: ${{ github.workspace }}

# 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 }}

# Path to the values file to use for generating the documentation.
# See https://github.com/losisin/helm-values-schema-json-action.
values-file: ""
Expand Down Expand Up @@ -68,19 +74,21 @@ 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-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>. | | |
| **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 <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
12 changes: 11 additions & 1 deletion actions/helm/generate-docs/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ inputs:
description: "Working directory"
required: false
default: "${{ github.workspace }}"
checkout-ref:
description: |
The Git ref to checkout before generating documentation.
Can be a branch, tag or commit SHA.
Set to an empty string to skip checkout.
required: false
default: ${{ github.ref }}
values-file:
description: |
Path to the values file to use for generating the documentation.
Expand Down Expand Up @@ -129,7 +136,10 @@ runs:
}
core.setOutput("markdownlint-config-path", markdownlintConfigPath);

- uses: hoverkraft-tech/ci-github-common/actions/checkout@b553a696531fbd36743ccbb0c76c717971b8acdb # 0.35.4
- if: ${{ inputs.checkout-ref != '' }}
uses: hoverkraft-tech/ci-github-common/actions/checkout@b553a696531fbd36743ccbb0c76c717971b8acdb # 0.35.4
with:
ref: ${{ inputs.checkout-ref }}

- uses: losisin/helm-docs-github-action@3a4528e97c49a5e83de6b78c50c61c8ee5c9f944 # v2.0.0
with:
Expand Down
Loading