Skip to content

Commit 5281ded

Browse files
committed
helm: remove version related info from templates as it is non-relevant (valid info is generated packaging time)
Signed-off-by: Peter Wilcsinszky <[email protected]>
1 parent b154f8c commit 5281ded

File tree

3 files changed

+17
-13
lines changed

3 files changed

+17
-13
lines changed

charts-docs/templates/README.md.gotmpl

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{{ template "chart.header" . }}
22

3-
{{ template "chart.versionBadge" . }} {{ template "chart.typeBadge" . }} {{ template "chart.appVersionBadge" . }} {{ template "chart.kubeVersionBadge" . }} {{ template "chart.artifactHubBadge" . }}
3+
{{ template "chart.typeBadge" . }} {{ template "chart.kubeVersionBadge" . }} {{ template "chart.artifactHubBadge" . }}
44

55
{{ template "chart.description" . }}
66

charts-docs/templates/overrides.gotmpl

+8-10
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
1-
{{- define "chart.versionBadge" -}}
2-
![version: {{ .Version }}](https://img.shields.io/badge/version-{{ .Version | replace "-" "--" }}-informational?style=flat-square)
3-
{{- end -}}
4-
51
{{- define "chart.typeBadge" -}}
62
{{- if .Type -}}![type: {{ .Type }}](https://img.shields.io/badge/type-{{ .Type }}-informational?style=flat-square){{- end -}}
73
{{- end -}}
84

9-
{{- define "chart.appVersionBadge" -}}
10-
{{- if .AppVersion -}}![app version: {{ .AppVersion }}](https://img.shields.io/badge/app%20version-{{ .AppVersion | replace "-" "--" }}-informational?style=flat-square){{- end -}}
11-
{{- end -}}
12-
135
{{- define "chart.kubeVersionBadge" -}}
146
{{- if .KubeVersion -}}![kube version: {{ .KubeVersion }}](https://img.shields.io/badge/kube%20version-{{ .KubeVersion | replace "-" "--" }}-informational?style=flat-square){{- end -}}
157
{{- end -}}
@@ -22,12 +14,18 @@
2214
## TL;DR;
2315

2416
```bash
25-
helm install --generate-name --wait oci://ghcr.io/kube-logging/helm-charts/{{ .Name }} --version {{ .Version }}
17+
helm install --generate-name --wait oci://ghcr.io/kube-logging/helm-charts/{{ .Name }}
18+
```
19+
20+
or to install with a specific version:
21+
22+
```bash
23+
helm install --generate-name --wait oci://ghcr.io/kube-logging/helm-charts/{{ .Name }} --version $VERSION
2624
```
2725
{{- end -}}
2826

2927
{{- define "chart.badges" -}}
30-
{{ template "chart.versionBadge" . }} {{ template "chart.typeBadge" . }} {{ template "chart.appVersionBadge" . }} {{ template "chart.kubeVersionBadge" . }} {{ template "chart.artifactHubBadge" . }}
28+
{{ template "chart.typeBadge" . }} {{ template "chart.kubeVersionBadge" . }} {{ template "chart.artifactHubBadge" . }}
3129
{{- end -}}
3230

3331
{{- define "chart.baseHead" -}}

charts/logging-operator/README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# logging-operator
22

3-
![version: 0.0.0](https://img.shields.io/badge/version-0.0.0-informational?style=flat-square) ![type: application](https://img.shields.io/badge/type-application-informational?style=flat-square) ![app version: latest](https://img.shields.io/badge/app%20version-latest-informational?style=flat-square) ![kube version: >=1.22.0-0](https://img.shields.io/badge/kube%20version->=1.22.0--0-informational?style=flat-square) [![artifact hub](https://img.shields.io/badge/artifact%20hub-logging--operator-informational?style=flat-square)](https://artifacthub.io/packages/helm/kube-logging/logging-operator)
3+
![type: application](https://img.shields.io/badge/type-application-informational?style=flat-square) ![kube version: >=1.22.0-0](https://img.shields.io/badge/kube%20version->=1.22.0--0-informational?style=flat-square) [![artifact hub](https://img.shields.io/badge/artifact%20hub-logging--operator-informational?style=flat-square)](https://artifacthub.io/packages/helm/kube-logging/logging-operator)
44

55
Logging operator for Kubernetes based on Fluentd and Fluentbit.
66

@@ -9,7 +9,13 @@ Logging operator for Kubernetes based on Fluentd and Fluentbit.
99
## TL;DR;
1010

1111
```bash
12-
helm install --generate-name --wait oci://ghcr.io/kube-logging/helm-charts/logging-operator --version 0.0.0
12+
helm install --generate-name --wait oci://ghcr.io/kube-logging/helm-charts/logging-operator
13+
```
14+
15+
or to install with a specific version:
16+
17+
```bash
18+
helm install --generate-name --wait oci://ghcr.io/kube-logging/helm-charts/logging-operator --version $VERSION
1319
```
1420

1521
## Introduction

0 commit comments

Comments
 (0)