https://github.com/user-cube/helm-template
Template for repositories using helmchart.
https://github.com/user-cube/helm-template
helm helm-charts
Last synced: 5 months ago
JSON representation
Template for repositories using helmchart.
- Host: GitHub
- URL: https://github.com/user-cube/helm-template
- Owner: user-cube
- Created: 2025-05-24T23:10:48.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-24T23:55:50.000Z (about 1 year ago)
- Last Synced: 2025-05-25T01:03:29.941Z (about 1 year ago)
- Topics: helm, helm-charts
- Language: Smarty
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# helm-template
Template for repositories using helmchart.
## Pre-commit Hooks
This repository uses [pre-commit](https://pre-commit.com/) to ensure code quality and consistency for YAML, Helm, and Kubernetes manifests.
### Tool Installation
Before using pre-commit hooks, make sure you have the following tools installed:
```bash
# Install pre-commit
pip install pre-commit
# or
brew install pre-commit
# Install Helm (if not already installed)
brew install helm
# or follow instructions at https://helm.sh/docs/intro/install/
# Install prettier (for YAML formatting, if you want to run it manually)
npm install -g prettier
# Install yamllint (for YAML linting, if you want to run it manually)
pip install yamllint
# Install kubeconform (for Kubernetes manifest validation)
brew install kubeconform
# or download from https://github.com/yannh/kubeconform#installation
# Install chart-testing
brew install chart-testing
# or download from https://github.com/helm/chart-testing
```
## Setup pre-commit
1. Install pre-commit (if you don't have it):
```bash
pip install pre-commit
# or
brew install pre-commit
```
2. Install the hooks:
```bash
pre-commit install
```
This will automatically run the configured hooks on staged files during `git commit`.
## Tests
### Setup
Install test framework tool:
```bash
helm plugin install https://github.com/helm-unittest/helm-unittest
```
### Execute tests
Execute the following command:
```bash
helm unittest src -f '../tests/**/*.yaml' -f '../tests/**/*.yml'
```
## Docs
## Setup
```bash
brew install helm-docs
```
## Generate docs
```bash
helm-docs src
```