Auto-generate chart README [no ci]

[beets] Add beets chart (#1284 )
docs: add titilambert as a contributor for code (#1282 )
2021-11-19 17:59:56 +00:00 · 2021-11-19 12:59:34 -05:00 · 2021-11-18 02:47:04 -05:00 · 2021-11-18 02:45:59 -05:00 · 2021-11-14 09:48:38 -05:00
15 changed files with 439 additions and 6 deletions
--- a/.all-contributorsrc
+++ b/.all-contributorsrc
@@ -364,6 +364,24 @@
      "contributions": [
        "code"
      ]
+    },
+    {
+      "login": "PixelJonas",
+      "name": "Jonas Janz",
+      "avatar_url": "https://avatars.githubusercontent.com/u/5434875?v=4",
+      "profile": "https://github.com/PixelJonas",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "titilambert",
+      "name": "Thibault Cohen",
+      "avatar_url": "https://avatars.githubusercontent.com/u/47721?v=4",
+      "profile": "https://twitter.com/ttb_lt",
+      "contributions": [
+        "code"
+      ]
    }
  ],
  "contributorsPerLine": 7,
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Helm charts
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-40-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-42-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->

 [![docs](https://img.shields.io/badge/docs-rtfm-yellow?logo=gitbook&logoColor=white&style=for-the-badge)](https://docs.k8s-at-home.com/)
@@ -98,6 +98,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
    <td align="center"><a href="https://github.com/brenix"><img src="https://avatars.githubusercontent.com/u/1131159?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Paul N</b></sub></a><br /><a href="https://github.com/k8s-at-home/charts/commits?author=brenix" title="Code">💻</a></td>
    <td align="center"><a href="https://www.varac.net"><img src="https://avatars.githubusercontent.com/u/488213?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Varac</b></sub></a><br /><a href="https://github.com/k8s-at-home/charts/commits?author=varac" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/CoolMintChocolate"><img src="https://avatars.githubusercontent.com/u/70276626?v=4?s=100" width="100px;" alt=""/><br /><sub><b>CoolMintChocolate</b></sub></a><br /><a href="https://github.com/k8s-at-home/charts/commits?author=CoolMintChocolate" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/PixelJonas"><img src="https://avatars.githubusercontent.com/u/5434875?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jonas Janz</b></sub></a><br /><a href="https://github.com/k8s-at-home/charts/commits?author=PixelJonas" title="Code">💻</a></td>
+    <td align="center"><a href="https://twitter.com/ttb_lt"><img src="https://avatars.githubusercontent.com/u/47721?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Thibault Cohen</b></sub></a><br /><a href="https://github.com/k8s-at-home/charts/commits?author=titilambert" title="Code">💻</a></td>
  </tr>
 </table>

--- a/charts/stable/beets/.helmignore
+++ b/charts/stable/beets/.helmignore
@@ -0,0 +1,26 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/
+# OWNERS file for Kubernetes
+OWNERS
+# helm-docs templates
+*.gotmpl
--- a/charts/stable/beets/Chart.yaml
+++ b/charts/stable/beets/Chart.yaml
@@ -0,0 +1,20 @@
+apiVersion: v2
+appVersion: 1.5.0
+description: beets helm package
+name: beets
+version: 1.0.0
+kubeVersion: ">=1.16.0-0"
+keywords:
+- beets
+home: https://github.com/k8s-at-home/charts/tree/master/charts/stable/beets
+icon: https://pbs.twimg.com/profile_images/934307246/logo-square_400x400.png
+sources:
+- https://github.com/beetbox/beets
+- https://github.com/linuxserver/docker-beets
+maintainers:
+- name: dangmai
+  email: contact@dangmai.net
+dependencies:
+- name: common
+  repository: https://library-charts.k8s-at-home.com
+  version: 4.1.0
--- a/charts/stable/beets/README.md
+++ b/charts/stable/beets/README.md
@@ -0,0 +1,120 @@
+# beets
+
+![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.5.0](https://img.shields.io/badge/AppVersion-1.5.0-informational?style=flat-square)
+
+beets helm package
+
+**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
+
+* <https://github.com/beetbox/beets>
+* <https://github.com/linuxserver/docker-beets>
+
+## Requirements
+
+Kubernetes: `>=1.16.0-0`
+
+## Dependencies
+
+| Repository | Name | Version |
+|------------|------|---------|
+| https://library-charts.k8s-at-home.com | common | 4.1.0 |
+
+## TL;DR
+
+```console
+helm repo add k8s-at-home https://k8s-at-home.com/charts/
+helm repo update
+helm install beets k8s-at-home/beets
+```
+
+## Installing the Chart
+
+To install the chart with the release name `beets`
+
+```console
+helm install beets k8s-at-home/beets
+```
+
+## Uninstalling the Chart
+
+To uninstall the `beets` deployment
+
+```console
+helm uninstall beets
+```
+
+The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
+
+## Configuration
+
+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/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common).
+
+Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
+
+```console
+helm install beets \
+  --set env.TZ="America/New York" \
+    k8s-at-home/beets
+```
+
+Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
+
+```console
+helm install beets k8s-at-home/beets -f values.yaml
+```
+
+## Custom configuration
+
+N/A
+
+## Values
+
+**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common)
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| env | object | See below | environment variables. See more environment variables in the [beets documentation](https://beets.org/docs). |
+| env.PGID | string | `"1001"` | Set the container group id |
+| env.PUID | string | `"1001"` | Set the container user id |
+| env.TZ | string | `"UTC"` | Set the container timezone |
+| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
+| image.repository | string | `"linuxserver/beets"` | image repository |
+| image.tag | string | `"1.5.0"` | 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. |
+| 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]
+
+#### Added
+
+- Initial version
+
+#### Changed
+
+- N/A
+
+#### Removed
+
+- N/A
+
+[1.0.0]: #100
+
+## Support
+
+- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
+- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
+- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
+- 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)
--- a/charts/stable/beets/README.md.gotmpl
+++ b/charts/stable/beets/README.md.gotmpl
@@ -0,0 +1,146 @@
+{{- define "custom.repository.organization" -}}
+k8s-at-home
+{{- end -}}
+
+{{- define "custom.repository.url" -}}
+https://github.com/k8s-at-home/charts
+{{- end -}}
+
+{{- define "custom.helm.url" -}}
+https://k8s-at-home.com/charts/
+{{- end -}}
+
+{{- define "custom.helm.path" -}}
+{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
+{{- end -}}
+
+{{- define "custom.notes" -}}
+**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)**
+{{- 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/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/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 our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common)
+
+{{ template "chart.valuesTable" . }}
+{{- end -}}
+
+{{- define "custom.support" -}}
+## Support
+
+- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
+- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
+- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
+- Join our [Discord](https://discord.gg/sTMX7Vh) community
+{{- 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" . }}
+
+{{ template "custom.dependencies" . }}
+
+{{ template "custom.install.tldr" . }}
+
+{{ template "custom.install" . }}
+
+{{ template "custom.uninstall" . }}
+
+{{ template "custom.configuration.header" . }}
+
+{{ template "custom.configuration.readValues" . }}
+
+{{ template "custom.configuration.example.set" . }}
+
+{{ template "custom.configuration.example.file" . }}
+
+{{ template "custom.custom.configuration" . }}
+
+{{ template "custom.valuesSection" . }}
+
+{{ template "custom.changelog" . }}
+
+{{ template "custom.support" . }}
+
+{{ template "helm-docs.versionFooter" . }}
+{{ "" }}
--- a/charts/stable/beets/README_CHANGELOG.md.gotmpl
+++ b/charts/stable/beets/README_CHANGELOG.md.gotmpl
@@ -0,0 +1,27 @@
+{{- define "custom.changelog.header" -}}
+## Changelog
+{{- end -}}
+
+{{- define "custom.changelog" -}}
+{{ template "custom.changelog.header" . }}
+
+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]
+
+#### Added
+
+- Initial version
+
+#### Changed
+
+- N/A
+
+#### Removed
+
+- N/A
+
+[1.0.0]: #100
+{{- end -}}
--- a/charts/stable/beets/README_CONFIG.md.gotmpl
+++ b/charts/stable/beets/README_CONFIG.md.gotmpl
@@ -0,0 +1,9 @@
+{{- define "custom.custom.configuration.header" -}}
+## Custom configuration
+{{- end -}}
+
+{{- define "custom.custom.configuration" -}}
+{{ template "custom.custom.configuration.header" . }}
+
+N/A
+{{- end -}}
--- a/charts/stable/beets/templates/NOTES.txt
+++ b/charts/stable/beets/templates/NOTES.txt
@@ -0,0 +1 @@
+{{- include "common.notes.defaultNotes" . -}}
--- a/charts/stable/beets/templates/common.yaml
+++ b/charts/stable/beets/templates/common.yaml
@@ -0,0 +1 @@
+{{ include "common.all" . }}
--- a/charts/stable/beets/values.yaml
+++ b/charts/stable/beets/values.yaml
@@ -0,0 +1,51 @@
+#
+# IMPORTANT NOTE
+#
+# This chart inherits from our common library chart. You can check the default values/options here:
+# https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml
+#
+
+image:
+  # -- image repository
+  repository: linuxserver/beets
+  # -- image tag
+  tag: 1.5.0
+  # -- image pull policy
+  pullPolicy: IfNotPresent
+
+# -- environment variables. See more environment variables in the [beets documentation](https://beets.org/docs).
+# @default -- See below
+env:
+  # -- Set the container timezone
+  TZ: UTC
+  # -- Set the container user id
+  PUID: "1001"
+  # -- Set the container group id
+  PGID: "1001"
+
+# -- Configures service settings for the chart.
+# @default -- See values.yaml
+service:
+  main:
+    ports:
+      http:
+        port: 8337
+
+ingress:
+  # -- Enable and configure ingress settings for the chart under this key.
+  # @default -- See values.yaml
+  main:
+    enabled: false
+
+# -- Configure persistence settings for the chart under this key.
+# @default -- See values.yaml
+persistence:
+  config:
+    enabled: false
+    mountPath: /config
+  music:
+    enabled: false
+    mountPath: /music
+  ingest:
+    enabled: false
+    mountPath: /downloads
--- a/charts/stable/photoprism/Chart.yaml
+++ b/charts/stable/photoprism/Chart.yaml
@@ -1,8 +1,8 @@
 apiVersion: v2
-appVersion: "20210523"
+appVersion: "20211018"
 description: PhotoPrism® is a server-based application for browsing, organizing and sharing your personal photo collection
 name: photoprism
-version: 6.0.1
+version: 6.1.0
 kubeVersion: ">=1.16.0-0"
 keywords:
 - photos
--- a/charts/stable/photoprism/README.md
+++ b/charts/stable/photoprism/README.md
@@ -1,6 +1,6 @@
 # photoprism

-![Version: 6.0.1](https://img.shields.io/badge/Version-6.0.1-informational?style=flat-square) ![AppVersion: 20210523](https://img.shields.io/badge/AppVersion-20210523-informational?style=flat-square)
+![Version: 6.1.0](https://img.shields.io/badge/Version-6.1.0-informational?style=flat-square) ![AppVersion: 20211018](https://img.shields.io/badge/AppVersion-20211018-informational?style=flat-square)

 PhotoPrism® is a server-based application for browsing, organizing and sharing your personal photo collection

@@ -87,7 +87,7 @@ N/A
 | env.UMASK | string | `nil` | Sets UMASK. |
 | image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
 | image.repository | string | `"photoprism/photoprism"` | image repository |
-| image.tag | string | `"20210523"` | image tag |
+| image.tag | string | `"20211018"` | 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. |
 | service | object | See values.yaml | Configures service settings for the chart. |
@@ -98,6 +98,12 @@ All notable changes to this application Helm chart will be documented in this fi

 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).

+### [6.1.0]
+
+#### Changed
+
+- Upgrade Photoprism to version 20211018
+
 ### [6.0.0]

 #### Changed
--- a/charts/stable/photoprism/README_CHANGELOG.md.gotmpl
+++ b/charts/stable/photoprism/README_CHANGELOG.md.gotmpl
@@ -9,6 +9,12 @@ All notable changes to this application Helm chart will be documented in this fi

 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).

+### [6.1.0]
+
+#### Changed
+
+- Upgrade Photoprism to version 20211018
+
 ### [6.0.0]

 #### Changed
--- a/charts/stable/photoprism/values.yaml
+++ b/charts/stable/photoprism/values.yaml
@@ -9,7 +9,7 @@ image:
  # -- image repository
  repository: photoprism/photoprism
  # -- image tag
-  tag: "20210523"
+  tag: "20211018"
  # -- image pull policy
  pullPolicy: IfNotPresent
Author	SHA1	Message	Date
k8s-at-home[bot]	18fe0f7516	Auto-generate chart README [no ci]	2021-11-19 17:59:56 +00:00
Dang Mai	13371cfc2e	[beets] Add beets chart (#1284 )	2021-11-19 12:59:34 -05:00
allcontributors[bot]	d860835181	docs: add titilambert as a contributor for code (#1282 ) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>	2021-11-18 02:47:04 -05:00
Thibault Cohen	e1f44492af	[photoprism] Update photoprism image (#1267 ) * [photoprism] Update photoprism image * Update Chart.yaml * Update README_CHANGELOG.md.gotmpl * Fix PR comments Co-authored-by: Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs <me@bjw-s.dev>	2021-11-18 02:45:59 -05:00
allcontributors[bot]	bbb4aa6c7c	docs: add PixelJonas as a contributor for code (#1277 ) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>	2021-11-14 09:48:38 -05:00
				`@@ -0,0 +1 @@`
				`{{- include "common.notes.defaultNotes" . -}}`