diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 63af32a..3022f5b 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,6 @@ repos: - repo: https://github.com/norwoodj/helm-docs - rev: v0.8.0 + rev: v1.2.0 hooks: - id: helm-docs args: diff --git a/example-charts/custom-template/README.md.gotmpl b/example-charts/custom-template/README.md.gotmpl index cb9e321..ab96848 100644 --- a/example-charts/custom-template/README.md.gotmpl +++ b/example-charts/custom-template/README.md.gotmpl @@ -25,3 +25,5 @@ $ helm install my-release foo-bar/{{ template "chart.name" . }} {{ template "chart.requirementsSection" . }} {{ template "chart.valuesSection" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/example-charts/full-template/README.md.gotmpl b/example-charts/full-template/README.md.gotmpl index 42abaea..a01c2f9 100644 --- a/example-charts/full-template/README.md.gotmpl +++ b/example-charts/full-template/README.md.gotmpl @@ -103,3 +103,5 @@ ## `chart.valuesSection` {{ template "chart.valuesSection" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/example-charts/helm-3/README.md b/example-charts/helm-3/README.md index 5db4c0c..b9b6b6e 100644 --- a/example-charts/helm-3/README.md +++ b/example-charts/helm-3/README.md @@ -40,5 +40,3 @@ A simple wrapper around the stable/nginx-ingress chart that adds a few of our co | controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service | | controller.service.type | string | `"LoadBalancer"` | | ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.1.0](https://github.com/norwoodj/helm-docs/releases/1.1.0) diff --git a/example-charts/most-empty/README.md.gotmpl b/example-charts/most-empty/README.md.gotmpl index 0681139..a007a0a 100644 --- a/example-charts/most-empty/README.md.gotmpl +++ b/example-charts/most-empty/README.md.gotmpl @@ -12,3 +12,5 @@ There is a flower though: {{ template "chart.requirementsSection" . }} {{ template "chart.valuesSection" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/example-charts/nginx-ingress-but-auto-comments/README.md b/example-charts/nginx-ingress-but-auto-comments/README.md index 6e9c609..c24bb62 100644 --- a/example-charts/nginx-ingress-but-auto-comments/README.md +++ b/example-charts/nginx-ingress-but-auto-comments/README.md @@ -40,5 +40,3 @@ A simple wrapper around the stable/nginx-ingress chart that adds a few of our co | controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service | | controller.service.type | string | `"LoadBalancer"` | | ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.1.0](https://github.com/norwoodj/helm-docs/releases/1.1.0) diff --git a/example-charts/nginx-ingress/README.md b/example-charts/nginx-ingress/README.md index b9cd407..91a5471 100644 --- a/example-charts/nginx-ingress/README.md +++ b/example-charts/nginx-ingress/README.md @@ -40,5 +40,3 @@ A simple wrapper around the stable/nginx-ingress chart that adds a few of our co | controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service | | controller.service.type | string | `"LoadBalancer"` | | ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.1.0](https://github.com/norwoodj/helm-docs/releases/1.1.0) diff --git a/example-charts/no-requirements/README.md b/example-charts/no-requirements/README.md index eaf8820..48a9161 100644 --- a/example-charts/no-requirements/README.md +++ b/example-charts/no-requirements/README.md @@ -25,5 +25,3 @@ A simple chart that installs, let's say PrometheusRules, that needs no sub-chart | rules.statusCodes.codes.5xx.duration | string | `"5m"` | Duration for which the percent of 5xx responses must be above the threshold to alert | | rules.statusCodes.codes.5xx.threshold | float | `1.5` | Threshold percentage of 5xx responses above which the alert will fire | ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.1.0](https://github.com/norwoodj/helm-docs/releases/1.1.0) diff --git a/example-charts/special-characters-but-auto-comments/README.md b/example-charts/special-characters-but-auto-comments/README.md index cd26c6e..55ee98f 100644 --- a/example-charts/special-characters-but-auto-comments/README.md +++ b/example-charts/special-characters-but-auto-comments/README.md @@ -26,5 +26,3 @@ A chart demonstrating handling of special characters in values files | htmlSnippets.three | string | `""` | Another description | | htmlSnippets.two | string | `""` | Let's put it in the description | ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.1.0](https://github.com/norwoodj/helm-docs/releases/1.1.0) diff --git a/example-charts/special-characters/README.md b/example-charts/special-characters/README.md index cd26c6e..55ee98f 100644 --- a/example-charts/special-characters/README.md +++ b/example-charts/special-characters/README.md @@ -26,5 +26,3 @@ A chart demonstrating handling of special characters in values files | htmlSnippets.three | string | `""` | Another description | | htmlSnippets.two | string | `""` | Let's put it in the description | ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.1.0](https://github.com/norwoodj/helm-docs/releases/1.1.0)