From 2eedb285e834d5bc0428faf7f8df6c956bfba4c0 Mon Sep 17 00:00:00 2001 From: "Nicholas St. Germain" Date: Sun, 13 Sep 2020 05:08:51 -0500 Subject: [PATCH] add artifacthub badge --- README.md | 2 +- charts/README.templates.md.gotmpl | 4 +++- charts/traefik-forward-auth/README.md | 2 +- charts/traefik-forward-auth/README.md.gotmpl | 2 +- 4 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 03b48635..b8e9de1a 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![](https://github.com/k8s-at-home/charts/workflows/Release%20Charts/badge.svg?branch=master)](https://github.com/k8s-at-home/charts/actions) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) - +[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/k8s-at-home)](https://artifacthub.io/packages/search?repo=k8s-at-home) ## Usage [Helm](https://helm.sh) must be installed to use the charts. diff --git a/charts/README.templates.md.gotmpl b/charts/README.templates.md.gotmpl index fab3590c..7b8b4173 100644 --- a/charts/README.templates.md.gotmpl +++ b/charts/README.templates.md.gotmpl @@ -13,7 +13,9 @@ {{- define "helm.path" -}} {{ template "repository.organization" . }}/{{ template "chart.name" . }} {{- end -}} - +{{- define "badge.artifactHub" -}} + [![ArtifactHub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/{{ template "chart.name" . }})](https://artifacthub.io/packages/helm/{{ template "chart.name" . }}) +{{- end -}} {{- define "description.multiarch" -}} The default values and container images used in this chart will allow for running in a multi-arch cluster (amd64, arm, arm64) {{- end -}} diff --git a/charts/traefik-forward-auth/README.md b/charts/traefik-forward-auth/README.md index eb272779..54398c00 100644 --- a/charts/traefik-forward-auth/README.md +++ b/charts/traefik-forward-auth/README.md @@ -1,6 +1,6 @@ # traefik-forward-auth -![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 2.2.0](https://img.shields.io/badge/AppVersion-2.2.0-informational?style=flat-square) +![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 2.2.0](https://img.shields.io/badge/AppVersion-2.2.0-informational?style=flat-square) [![ArtifactHub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/traefik-forward-auth)](https://artifacthub.io/packages/helm/traefik-forward-auth) A minimal forward authentication service that provides OAuth/SSO login and authentication for the traefik reverse proxy/load balancer diff --git a/charts/traefik-forward-auth/README.md.gotmpl b/charts/traefik-forward-auth/README.md.gotmpl index d1cc7522..d51bacfc 100644 --- a/charts/traefik-forward-auth/README.md.gotmpl +++ b/charts/traefik-forward-auth/README.md.gotmpl @@ -1,5 +1,5 @@ {{ template "chart.header" . }} -{{ template "chart.typeBadge" . }}{{ template "chart.versionBadge" . }}{{ template "chart.appVersionBadge" . }} +{{ template "chart.typeBadge" . }}{{ template "chart.versionBadge" . }}{{ template "chart.appVersionBadge" . }}{{ template "badge.artifactHub" . }} {{ template "chart.description" . }}