diff --git a/.github/workflows/helm-docs.yaml b/.github/workflows/helm-docs.yaml new file mode 100644 index 00000000..a6b2c22e --- /dev/null +++ b/.github/workflows/helm-docs.yaml @@ -0,0 +1,30 @@ +# Copyright (c) Magistrala +# SPDX-License-Identifier: Apache-2.0 + +name: Generate Helm Docs + +on: + push: + branches: + - master + +jobs: + generate-docs: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + with: + repository: ${{ github.repository }} + ref: ${{ github.ref }} + fetch-depth: 0 + + - name: Generate Helm Docs + uses: losisin/helm-docs-github-action@v1.3.1 + with: + chart-search-root: "charts/magistrala" + values-file: "values.yaml" + output-file: "README.md" + template-files: "README.md.gotmpl" + git-push: false + fail-on-diff: true diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 95e740e0..233e3472 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -15,10 +15,8 @@ jobs: runs-on: ubuntu-latest steps: - - name: Checkout Code - uses: actions/checkout@v4 - with: - fetch-depth: 0 + - name: Call Common Steps + uses: ./.github/workflows/common.yaml - name: Configure Git run: | @@ -43,7 +41,19 @@ jobs: run: | helm dependency update charts/magistrala + - name: Add Dependencies + run: | + helm repo add stable https://charts.helm.sh/stable + helm repo add bitnami https://charts.bitnami.com/bitnami + helm repo add jaegertracing https://jaegertracing.github.io/helm-charts + helm repo add hashicorp https://helm.releases.hashicorp.com + helm repo add nats https://nats-io.github.io/k8s/helm/charts/ + helm repo update + - name: Run chart-releaser uses: helm/chart-releaser-action@v1.6.0 + with: + charts_dir: charts/magistrala + config: cr.yaml env: CR_TOKEN: "${{ secrets.HELM_RELEASE_TOKEN }}" diff --git a/charts/magistrala/README.md b/charts/magistrala/README.md index ed52d3eb..702c445f 100644 --- a/charts/magistrala/README.md +++ b/charts/magistrala/README.md @@ -1,9 +1,9 @@ # magistrala -![Version: 1.0.6](https://img.shields.io/badge/Version-1.0.6-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.14.0](https://img.shields.io/badge/AppVersion-0.14.0-informational?style=flat-square) - Magistrala IoT Platform +![Version: 1.0.6](https://img.shields.io/badge/Version-1.0.6-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.14.0](https://img.shields.io/badge/AppVersion-0.14.0-informational?style=flat-square) + **Homepage:** ## Maintainers @@ -308,5 +308,4 @@ Magistrala IoT Platform | users.passwordRegex | string | `"^.{8,}$"` | | | users.secretKey | string | `"secretKey"` | | | users.tokenResetEndpoint | string | `"/reset-request"` | | -| vault.enabled | bool | `false` | | - +| vault.enabled | bool | `false` | | \ No newline at end of file diff --git a/charts/magistrala/README.md.gotmpl b/charts/magistrala/README.md.gotmpl new file mode 100644 index 00000000..ee3618b8 --- /dev/null +++ b/charts/magistrala/README.md.gotmpl @@ -0,0 +1,15 @@ +{{ template "chart.header" . }} + +{{ template "chart.description" . }} + +{{ template "chart.badgesSection" . }} + +{{ template "chart.homepageLine" . }} + +{{ template "chart.maintainersSection" . }} + +{{ template "chart.sourcesSection" . }} + +{{ template "chart.requirementsSection" . }} + +{{ template "chart.valuesSection" . }}