Merge pull request #171 from mcavoyk/ci-helm-docs

ci: add helm.docs target to helm generate

.github/workflows/helm.yml

@@ -48,13 +48,6 @@ jobs:
       - name: Run chart-testing (lint)
         run: ct lint --config=.github/ci/ct.yaml
 
-      - name: Create kind cluster
-        uses: helm/kind-action@v1.1.0
-        if: steps.list-changed.outputs.changed == 'true'
-
-      - name: Run chart-testing (install)
-        run: ct install --config=.github/ci/ct.yaml
-
   release:
     runs-on: ubuntu-latest
     steps:

Makefile

@@ -155,8 +155,8 @@ crds.uninstall:
 # Helm Chart
 
 helm.docs: ## Generate helm docs
-	cd $(HELM_DIR); \
-	docker run --rm -v $(shell pwd)/$(HELM_DIR):/helm-docs -u $(shell id -u) jnorwood/helm-docs:latest
+	@cd $(HELM_DIR); \
+	docker run --rm -v $(shell pwd)/$(HELM_DIR):/helm-docs -u $(shell id -u) jnorwood/helm-docs:v1.5.0
 
 HELM_VERSION ?= $(shell helm show chart $(HELM_DIR) | grep 'version:' | sed 's/version: //g')
 
@@ -167,7 +167,7 @@ helm.build: helm.generate ## Build helm chart
 	@$(OK) helm package
 
 # Copy crds to helm chart directory
-helm.generate:
+helm.generate: helm.docs
 	@cp $(CRD_DIR)/*.yaml $(HELM_DIR)/templates/crds/
 # Add helm if statement for controlling the install of CRDs
 	@for i in $(HELM_DIR)/templates/crds/*.yaml; do \

deploy/charts/external-secrets/Chart.yaml

@@ -9,6 +9,7 @@ keywords:
   - kubernetes-external-secrets
   - secrets
 home: https://github.com/external-secrets/external-secrets
+icon: https://raw.githubusercontent.com/external-secrets/external-secrets/main/assets/round_eso_logo.png
 maintainers:
   - name: mcavoyk
     email: kellinmcavoy@gmail.com

deploy/charts/external-secrets/README.md

@@ -1,14 +1,16 @@
-# external-secrets
+# External Secrets
+
+<p align="left"><img src="https://raw.githubusercontent.com/external-secrets/external-secrets/main/assets/round_eso_logo.png" width="100x" /></p>
 
 [//]: # (README.md generated by gotmpl. DO NOT EDIT.)
 
-![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square)
+![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![Version: 0.1.4](https://img.shields.io/badge/Version-0.1.4-informational?style=flat-square)
 
 External secret management for Kubernetes
 
 ## TL;DR
 ```bash
-helm repo add external-secrets https://external-secrets.github.io/external-secrets
+helm repo add external-secrets https://charts.external-secrets.io
 helm install external-secrets/external-secrets
 ```
 
@@ -28,10 +30,6 @@ helm uninstall external-secrets
 ```
 The command removes all the Kubernetes components associated with the chart and deletes the release.
 
-## Configuration
-Read through the external-secrets [values.yaml](https://github.com/external-secrets/external-secrets/blob/master/deploy/charts/external-secrets/values.yaml)
-file. It has several commented out suggested values.
-
 ## Values
 
 | Key | Type | Default | Description |
@@ -45,7 +43,7 @@ file. It has several commented out suggested values.
 | image.tag | string | `""` | The image tag to use. The default is the chart appVersion. |
 | imagePullSecrets | list | `[]` |  |
 | installCRDs | bool | `true` | If set, install and upgrade CRDs through helm chart. |
-| leaderElect | bool | `true` | If true, external-secrets will perform leader election between instances to ensure no more than one instance of external-secrets operates at a time. |
+| leaderElect | bool | `false` | If true, external-secrets will perform leader election between instances to ensure no more than one instance of external-secrets operates at a time. |
 | nameOverride | string | `""` |  |
 | nodeSelector | object | `{}` |  |
 | podAnnotations | object | `{}` |  |

deploy/charts/external-secrets/README.md.gotmpl

@@ -1,11 +1,13 @@
 {{- $valuesYAML := "https://github.com/external-secrets/external-secrets/blob/master/deploy/charts/external-secrets/values.yaml" -}}
-{{- $chartRepo := "https://external-secrets.github.io/external-secrets" -}}
+{{- $chartRepo := "https://charts.external-secrets.io" -}}
 {{- $org := "external-secrets" -}}
-{{ template "chart.header" . }}
+# External Secrets
+
+<p align="left"><img src="https://raw.githubusercontent.com/external-secrets/external-secrets/main/assets/round_eso_logo.png" width="100x" /></p>
 
 [//]: # (README.md generated by gotmpl. DO NOT EDIT.)
 
-{{ template "chart.typeBadge" . }}{{ template "chart.versionBadge" . }}{{ template "chart.appVersionBadge" . }}
+{{ template "chart.typeBadge" . }}{{ template "chart.versionBadge" . }}
 
 {{ template "chart.description" . }}
 
@@ -31,8 +33,4 @@ helm uninstall {{ template "chart.name" . }}
 ```
 The command removes all the Kubernetes components associated with the chart and deletes the release.
 
-## Configuration
-Read through the {{ template "chart.name" . }} [values.yaml]({{ $valuesYAML }})
-file. It has several commented out suggested values.
-
 {{ template "chart.valuesSection" . }}

deploy/charts/external-secrets/templates/crds/README.md

@@ -1,4 +1,4 @@
 # CRD Template Directory
-the CRDs are generated in pipeline during helm package. To install the CRDs please set `installCRDS: true`.
+CRDs are autogenerated during helm packaging. To install the CRDs set `installCRDS: true` during helm install or upgrade.
 
-The latest CRDs in the repository are located [here](../../../../../config/crd/bases)
+The latest CRDs in the repository are located [here](../../../../crds).