autoscaler/charts
Kubernetes Prow Robot 616cfb652e
Merge pull request #5762 from jackfrancis/helm-chart-clusterapi-clusterNamespace
helm: enable clusterapi namespace autodiscovery
2024-03-18 04:07:30 -07:00
..
cluster-autoscaler Merge pull request #5762 from jackfrancis/helm-chart-clusterapi-clusterNamespace 2024-03-18 04:07:30 -07:00
OWNERS Update Auto Labels of Subprojects 2024-02-05 23:00:59 +00:00
README.md Charts - Update Chart Lint and Test PR actions 2021-03-08 23:05:45 +00:00

README.md

charts

The Helm charts for the Autoscaler project reside within this folder. If making changes to the Helm charts, make sure you follow the instructions below for the pre-commit checks.

Pre-commit hooks

This Helm repository has pre-commit hooks for Helm specific needs:

  • Makes sure all charts pass a helm lint check.
  • Updates the README.md file of all charts based on comments in that chart's values.yaml file.

Install pre-commit binary

The binary for pre-commit can be installed via Homebrew:

$ brew install pre-commit

For those without Homebrew, Pre-commit has other installation methods available.

Install git hooks

After the pre-commit binary is installed, go to this repository's directory, and run the following command to install the git hook:

$ pre-commit install

Install hook dependencies

The pre-commit hooks themselves call binaries under the hood; they can be installed via the instructions found here.

Note: You should ensure that whichever installation method you are using you either install the same version of helm-docs as used in the PR workflow to ensure your PR passes CI checks or update the version used by the workflow to match.