kubernetes
/
autoscaler
mirror of https://github.com/kubernetes/autoscaler.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
autoscaler/charts
History
GuyTempleton 6c71ab2e84
Final remove of ca-chart chart post deprecation 		2021-02-12 19:57:26 +00:00
..
cluster-autoscaler Bump CA-Chart version to 9.4.0 2021-01-24 04:17:45 +09:00
OWNERS Update OWNERS 2020-08-04 13:11:33 -05:00
README.md Update helm-docs version and add PR action to ensure docs are updated 2020-10-07 23:53:33 +01: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

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.