mirror of
				https://github.com/TeamPiped/Piped-Kubernetes.git
				synced 2024-08-14 23:57:15 +00:00 
			
		
		
		
	Fix chart README generation.
This commit is contained in:
		
							parent
							
								
									e84aa7b6f4
								
							
						
					
					
						commit
						60153fd456
					
				
					 3 changed files with 37 additions and 204 deletions
				
			
		| 
						 | 
				
			
			@ -14,157 +14,41 @@ https://helm.piped.video
 | 
			
		|||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
 | 
			
		||||
{{- end -}}
 | 
			
		||||
 | 
			
		||||
{{- define "custom.notes" -}}
 | 
			
		||||
 | 
			
		||||
{{- end -}}
 | 
			
		||||
 | 
			
		||||
{{- define "custom.requirements" -}}
 | 
			
		||||
## Requirements
 | 
			
		||||
 | 
			
		||||
{{ template "chart.kubeVersionLine" . }}
 | 
			
		||||
{{- end -}}
 | 
			
		||||
 | 
			
		||||
{{- define "custom.dependencies" -}}
 | 
			
		||||
## Dependencies
 | 
			
		||||
 | 
			
		||||
{{ template "chart.requirementsTable" . }}
 | 
			
		||||
{{- end -}}
 | 
			
		||||
 | 
			
		||||
{{- define "custom.install.tldr" -}}
 | 
			
		||||
## TL;DR
 | 
			
		||||
 | 
			
		||||
```console
 | 
			
		||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
 | 
			
		||||
helm repo update
 | 
			
		||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
 | 
			
		||||
```
 | 
			
		||||
{{- end -}}
 | 
			
		||||
 | 
			
		||||
{{- define "custom.install" -}}
 | 
			
		||||
## Installing the Chart
 | 
			
		||||
 | 
			
		||||
To install the chart with the release name `{{ template "chart.name" . }}`
 | 
			
		||||
 | 
			
		||||
```console
 | 
			
		||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
 | 
			
		||||
```
 | 
			
		||||
{{- end -}}
 | 
			
		||||
 | 
			
		||||
{{- define "custom.uninstall" -}}
 | 
			
		||||
## Uninstalling the Chart
 | 
			
		||||
 | 
			
		||||
To uninstall the `{{ template "chart.name" . }}` deployment
 | 
			
		||||
 | 
			
		||||
```console
 | 
			
		||||
helm uninstall {{ template "chart.name" . }}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
 | 
			
		||||
{{- end -}}
 | 
			
		||||
 | 
			
		||||
{{- define "custom.configuration.header" -}}
 | 
			
		||||
## Configuration
 | 
			
		||||
{{- end -}}
 | 
			
		||||
 | 
			
		||||
{{- define "custom.configuration.readValues" -}}
 | 
			
		||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
 | 
			
		||||
Other values may be used from the [values.yaml](https://github.com/bjw-s/helm-charts/blob/main/charts/library/common/values.yaml) from the [common library](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common).
 | 
			
		||||
{{- end -}}
 | 
			
		||||
 | 
			
		||||
{{- define "custom.configuration.example.set" -}}
 | 
			
		||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
 | 
			
		||||
 | 
			
		||||
```console
 | 
			
		||||
helm install {{ template "chart.name" . }} \
 | 
			
		||||
  --set env.TZ="America/New York" \
 | 
			
		||||
    {{ template "custom.helm.path" . }}
 | 
			
		||||
```
 | 
			
		||||
{{- end -}}
 | 
			
		||||
 | 
			
		||||
{{- define "custom.configuration.example.file" -}}
 | 
			
		||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
 | 
			
		||||
 | 
			
		||||
```console
 | 
			
		||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
 | 
			
		||||
```
 | 
			
		||||
{{- end -}}
 | 
			
		||||
 | 
			
		||||
{{- define "custom.valuesSection" -}}
 | 
			
		||||
## Values
 | 
			
		||||
 | 
			
		||||
**Important**: When deploying an application Helm chart you can add more values from the common library chart [here](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common)
 | 
			
		||||
 | 
			
		||||
{{ template "chart.valuesTable" . }}
 | 
			
		||||
{{- end -}}
 | 
			
		||||
 | 
			
		||||
{{- define "custom.support" -}}
 | 
			
		||||
## Support
 | 
			
		||||
 | 
			
		||||
- Open an [issue](https://github.com/TeamPiped/Piped-Kubernetes/issues/new/choose)
 | 
			
		||||
{{- end -}}
 | 
			
		||||
 | 
			
		||||
{{- define "custom.changelog" -}}
 | 
			
		||||
{{ $changeTypes := list "added" "changed" "fixed" }}
 | 
			
		||||
## Changelog
 | 
			
		||||
 | 
			
		||||
### Version {{ template "chart.version" . }}
 | 
			
		||||
 | 
			
		||||
{{ range $changeType := $changeTypes }}
 | 
			
		||||
  {{- with (index $.Annotations "artifacthub.io/changes") }}
 | 
			
		||||
    {{- print "#### " ($changeType | title)  | nindent 0  }}
 | 
			
		||||
    {{- print "" | nindent 0  }}
 | 
			
		||||
    {{- $changesFound := false }}
 | 
			
		||||
    {{- $changes := ((print "changes:\n" .) | fromYaml).changes }}
 | 
			
		||||
    {{- range $changes }}
 | 
			
		||||
      {{- if eq .kind $changeType }}
 | 
			
		||||
        {{- print "* " .description  | nindent 0 }}
 | 
			
		||||
        {{- $changesFound = true }}
 | 
			
		||||
      {{- end }}
 | 
			
		||||
    {{- end }}
 | 
			
		||||
    {{- if not $changesFound }}
 | 
			
		||||
      {{- print "N/A" | nindent 0 }}
 | 
			
		||||
    {{- end }}
 | 
			
		||||
    {{- print "" | nindent 0  }}
 | 
			
		||||
  {{- end }}
 | 
			
		||||
{{- end }}
 | 
			
		||||
 | 
			
		||||
{{- end -}}
 | 
			
		||||
 | 
			
		||||
{{ template "chart.header" . }}
 | 
			
		||||
 | 
			
		||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
 | 
			
		||||
 | 
			
		||||
{{ template "chart.description" . }}
 | 
			
		||||
 | 
			
		||||
{{ template "custom.notes" . }}
 | 
			
		||||
 | 
			
		||||
{{ template "chart.sourcesSection" . }}
 | 
			
		||||
 | 
			
		||||
{{ template "custom.requirements" . }}
 | 
			
		||||
## Requirements
 | 
			
		||||
 | 
			
		||||
{{ template "custom.dependencies" . }}
 | 
			
		||||
{{ template "chart.kubeVersionLine" . }}
 | 
			
		||||
 | 
			
		||||
{{ template "custom.install.tldr" . }}
 | 
			
		||||
## Dependencies
 | 
			
		||||
 | 
			
		||||
{{ template "custom.install" . }}
 | 
			
		||||
{{ template "chart.requirementsTable" . }}
 | 
			
		||||
 | 
			
		||||
{{ template "custom.uninstall" . }}
 | 
			
		||||
## Installing the Chart
 | 
			
		||||
 | 
			
		||||
{{ template "custom.configuration.header" . }}
 | 
			
		||||
```bash
 | 
			
		||||
# Add the repository
 | 
			
		||||
helm repo add {{ template "custom.repository.organization" }} {{template "custom.helm.url"}}
 | 
			
		||||
 | 
			
		||||
{{ template "custom.configuration.readValues" . }}
 | 
			
		||||
# Install the chart
 | 
			
		||||
helm install {{ template "custom.repository.organization" }} piped -f values.yaml
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
{{ template "custom.configuration.example.set" . }}
 | 
			
		||||
## Values
 | 
			
		||||
 | 
			
		||||
{{ template "custom.configuration.example.file" . }}
 | 
			
		||||
The following table contains an overview of available values and their descriptions / default values.
 | 
			
		||||
 | 
			
		||||
{{ template "custom.custom.configuration" . }}
 | 
			
		||||
<details>
 | 
			
		||||
<summary>Expand</summary>
 | 
			
		||||
 | 
			
		||||
{{ template "custom.valuesSection" . }}
 | 
			
		||||
{{ template "chart.valuesTable" . }}
 | 
			
		||||
 | 
			
		||||
{{ template "custom.changelog" . }}
 | 
			
		||||
 | 
			
		||||
{{ template "custom.support" . }}
 | 
			
		||||
</details>
 | 
			
		||||
 | 
			
		||||
{{ template "helm-docs.versionFooter" . }}
 | 
			
		||||
{{ "" }}
 | 
			
		||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue