From d77018b24214ec6dc56d29e2e63f3fd9b755d402 Mon Sep 17 00:00:00 2001 From: "k8s-at-home[bot]" Date: Mon, 21 Feb 2022 20:16:32 +0000 Subject: [PATCH] chore: Auto-update chart README [skip ci] --- charts/stable/audiobookshelf/README.md | 35 ++++++++----------- charts/stable/audiobookshelf/README.md.gotmpl | 30 ++++++++++++++++ 2 files changed, 45 insertions(+), 20 deletions(-) diff --git a/charts/stable/audiobookshelf/README.md b/charts/stable/audiobookshelf/README.md index f546dcc4..916ba0aa 100644 --- a/charts/stable/audiobookshelf/README.md +++ b/charts/stable/audiobookshelf/README.md @@ -2,19 +2,17 @@ ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.6.69](https://img.shields.io/badge/AppVersion-1.6.69-informational?style=flat-square) -audiobookshelf is a Self-hosted audiobook server for managing and playing your audiobooks. +Self-hosted audiobook server for managing and playing your audiobooks **This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** ## Source Code -* * -* ## Requirements -Kubernetes: `>=1.16.0-0` +Kubernetes: `>= 1.16.0-0` ## Dependencies @@ -79,35 +77,32 @@ N/A |-----|------|---------|-------------| | env | object | See below | environment variables. See more environment variables in the [audiobookshelf documentation](https://hub.docker.com/r/advplyr/audiobookshelf) | | env.TZ | string | `"UTC"` | Set the container timezone | -| image.pullPolicy | string | `"IfNotPresent"` | image tag | -| image.repository | string | `"advplyr/audiobookshelf -"` | image repository | -| image.tag | string | `"1.6.69"` | image pull policy | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"advplyr/audiobookshelf"` | image repository | +| image.tag | string | chart.appVersion | image tag | | ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | -| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. | +| persistence | string | See values.yaml | Configure persistence settings for the chart under this key. | | service | object | See values.yaml | Configures service settings for the chart. | ## Changelog -All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common#changelog). - -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - -### [1.0.0] +### Version 1.0.0 #### Added -- Initial version +* Initial version #### Changed -- N/A +N/A -#### Removed +#### Fixed -- N/A +N/A -[1.0.0]: #100 +### Older versions + +A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/audiobookshelf?modal=changelog) ## Support @@ -117,4 +112,4 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - Join our [Discord](https://discord.gg/sTMX7Vh) community ---------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) +Autogenerated from chart metadata using [helm-docs v0.1.1](https://github.com/k8s-at-home/helm-docs/releases/v0.1.1) diff --git a/charts/stable/audiobookshelf/README.md.gotmpl b/charts/stable/audiobookshelf/README.md.gotmpl index 358abe31..94f7808a 100644 --- a/charts/stable/audiobookshelf/README.md.gotmpl +++ b/charts/stable/audiobookshelf/README.md.gotmpl @@ -106,6 +106,36 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - - Join our [Discord](https://discord.gg/sTMX7Vh) community {{- 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 }} + {{- range (print "changes:\n" . | fromYaml).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 }} + +### Older versions + +A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/{{- template "chart.name" . }}?modal=changelog) + +{{- end -}} + {{ template "chart.header" . }} {{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}