update README

Signed-off-by: JeffMboya <[email protected]>
absmach · Sep 11, 2024 · f982178 · f982178
1 parent 0b9fc3c
commit f982178
Show file tree

Hide file tree

Showing 2 changed files with 324 additions and 233 deletions.
diff --git a/.github/workflows/helm-docs.yaml b/.github/workflows/helm-docs.yaml
@@ -1,14 +1,30 @@
-name: Update Chart Metadata
+# Copyright (c) Magistrala
+# SPDX-License-Identifier: Apache-2.0
+
+name: Generate Helm Docs
 
 on:
   pull_request:
     branches:
       - '*'
 
-jobs:  
-  update-chart-metadata:    
-    runs-on: ubuntu-latest    
-    steps:      
-      - uses: actions/checkout@v4      
-      - uses: gabe565/[email protected]      
-      - run: helm-docs
+jobs:
+  generate-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          ref: ${{ github.event.pull_request.head.ref }}
+          fetch-depth: 0
+
+      - name: Generate Helm Docs
+        uses: losisin/[email protected]
+        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