Merge pull request #76 from tumido/fix-oci-top-readme

chore: fix OCI installation command in README

Author: tumido

.pre-commit-config.yaml

@@ -3,6 +3,7 @@ repos:
     rev: v1.2.0
     hooks:
       - id: helm-docs
+        files: (README\.md(\.gotmpl)?|(Chart|requirements|values)\.ya?ml)$
         args:
           # Make the tool search for charts only under the ``charts` directory
           - --chart-search-root=charts

README.md

@@ -38,7 +38,7 @@ Charts are also available in OCI format. The list of available charts can be fou
 Install one of the available charts:
 
 ```shell
-helm upgrade -i oci://ghcr.io/janus-idp/helm-backstage/backstage --version=<version>
+helm upgrade -i <release_name> oci://ghcr.io/janus-idp/helm-backstage/backstage --version=<version>
 ```
 
 ## Backstage Chart

charts/backstage/Chart.yaml

@@ -42,4 +42,4 @@ sources:
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 2.2.0
+version: 2.2.1

charts/backstage/README.md

@@ -2,7 +2,7 @@
 # Janus-IDP Backstage Helm Chart
 
 [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/janus-idp&style=flat-square)](https://artifacthub.io/packages/search?repo=janus-idp)
-![Version: 2.2.0](https://img.shields.io/badge/Version-2.2.0-informational?style=flat-square)
+![Version: 2.2.1](https://img.shields.io/badge/Version-2.2.1-informational?style=flat-square)
 ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
 
 A Helm chart for deploying a Backstage application
@@ -100,7 +100,7 @@ Chart is also available in OCI format. The list of available releases can be fou
 Install one of the available versions:
 
 ```shell
-helm upgrade -i oci://ghcr.io/janus-idp/helm-backstage/backstage --version=<version>
+helm upgrade -i <release_name> oci://ghcr.io/janus-idp/helm-backstage/backstage --version=<version>
 ```
 
 > **Tip**: List all releases using `helm list`
@@ -210,6 +210,7 @@ Please note that any custom modifications to how backstage is being exposed may
 ```yaml
 # values.yaml
 upstream:
+  backstage:
     appConfig:
       app:
         baseUrl: 'https://{{- include "janus-idp.hostname" . }}'

charts/backstage/README.md.gotmpl

@@ -94,7 +94,7 @@ Chart is also available in OCI format. The list of available releases can be fou
 Install one of the available versions:
 
 ```shell
-helm upgrade -i oci://ghcr.io/janus-idp/helm-backstage/backstage --version=<version>
+helm upgrade -i <release_name> oci://ghcr.io/janus-idp/helm-backstage/backstage --version=<version>
 ```
 
 > **Tip**: List all releases using `helm list`
@@ -177,6 +177,7 @@ Please note that any custom modifications to how backstage is being exposed may
 ```yaml
 # values.yaml
 upstream:
+  backstage:
     appConfig:
       app:
         baseUrl: 'https://{{"{{"}}- include "janus-idp.hostname" . {{"}}"}}'