Use pre-commit-configs

Signed-off-by: osamamagdy <[email protected]>

Author: osamamagdy

.github/workflows/pre-commit.yml

@@ -10,6 +10,7 @@ env:
   TF_DOCS_VERSION: v0.16.0
   TFLINT_VERSION: v0.44.1
   TF_VERSION: "1.3.4"
+  HELM_DOCS_VERSION: "1.7.0"
 permissions:
   contents: read
 jobs:
@@ -42,6 +43,12 @@ jobs:
           tar -zxvf terraform_docs.tar.gz terraform-docs
           chmod +x terraform-docs
           mv terraform-docs /usr/local/bin/
+      - name: Setup helm-docs
+        run: |
+          cd /tmp
+          wget https://github.com/norwoodj/helm-docs/releases/download/v${{env.HELM_DOCS_VERSION}}/helm-docs_${{env.HELM_DOCS_VERSION}}_Linux_x86_64.tar.gz
+          tar -xvf helm-docs_${{env.HELM_DOCS_VERSION}}_Linux_x86_64.tar.gz
+          sudo mv helm-docs /usr/local/sbin
       - name: Pre-commit checks
         uses: pre-commit/[email protected]
       - name: pre-commit-ci-lite

.github/workflows/publish.yml

@@ -12,6 +12,17 @@ jobs:
         run: |
           git config user.name "$GITHUB_ACTOR"
           git config user.email "[email protected]"
+      - name: "Install yq"
+        run: |
+          sudo snap install yq
+      - name: "Patch Chart.yaml to the current released version"
+        working-directory: helm/wrongsecrets-ctf-party/
+        run: |
+          RELEASE_VERSION="${GITHUB_REF#refs/*/}"
+          # Remove leading 'v' from git tag to create valid semver
+          RELEASE_VERSION="${RELEASE_VERSION//v}"
+          # patch the version & appVersion in the Chart.yaml to the release version
+          yq eval -i ".version = \"$RELEASE_VERSION\", .appVersion = \"$RELEASE_VERSION\"" Chart.yaml
       - name: install helm-docs
         env:
           HELM_DOCS_VERSION: "1.7.0"
@@ -22,7 +33,7 @@ jobs:
           sudo mv helm-docs /usr/local/sbin
       - name: Generate and Release Helm Docs
         run: |
-          helm-docs -t helm/wrongsecrets-ctf-party/README.md.gotmpl -o README.md
+          helm-docs -t helm/wrongsecrets-ctf-party/README.md.gotmpl -t helm/wrongsecrets-ctf-party/_template.gotmpl -o README.md
           cp helm/wrongsecrets-ctf-party/README.md /tmp/README.md
       - name: Update gh-pages branch
         uses: actions/checkout@v3
@@ -44,17 +55,6 @@ jobs:
           fi
       - name: Get back to original branch
         uses: actions/checkout@v3
-      - name: "Install yq"
-        run: |
-          sudo snap install yq
-      - name: "Patch Chart.yaml to the current released version"
-        working-directory: helm/wrongsecrets-ctf-party/
-        run: |
-          RELEASE_VERSION="${GITHUB_REF#refs/*/}"
-          # Remove leading 'v' from git tag to create valid semver
-          RELEASE_VERSION="${RELEASE_VERSION//v}"
-          # patch the version & appVersion in the Chart.yaml to the release version
-          yq eval -i ".version = \"$RELEASE_VERSION\", .appVersion = \"$RELEASE_VERSION\"" Chart.yaml
       - name: Run chart-releaser
         uses: helm/[email protected]
         with:

.pre-commit-config.yaml

@@ -31,6 +31,20 @@ repos:
           - "--args=--only=terraform_standard_module_structure"
           - "--args=--only=terraform_workspace_remote"
       - id: terraform_docs
+  - repo: https://github.com/norwoodj/helm-docs
+    rev: v1.2.0
+    hooks:
+      - id: helm-docs
+        args:
+          # Make the tool search for charts only under the `example-charts` directory
+          - --chart-search-root=helm
+
+          # The `./` makes it relative to the chart-search-root set above
+          - --template-files=./_templates.gotmpl
+
+          # Repeating the flag adds this to the list, now [./_templates.gotmpl, README.md.gotmpl]
+          # A base filename makes it relative to each chart directory found
+          - --template-files=README.md.gotmpl
   - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
     rev: v9.4.0
     hooks:

helm/wrongsecrets-ctf-party/Chart.yaml

@@ -3,7 +3,7 @@ name: wrongsecrets-ctf-party
 description: Run Multi User "Capture the Flags" or Security Trainings with OWASP Wrongsecrets
 icon: https://github.com/OWASP/wrongsecrets/blob/master/icon.png?raw=true
 
-home: https://github.com/
+home: https://owasp.org/www-project-wrongsecrets/
 sources:
   - https://github.com/OWASP/wrongsecrets-ctf-party
 

helm/wrongsecrets-ctf-party/README.md

@@ -38,8 +38,19 @@ To install the wrongsecrets-ctf-party chart:
 To uninstall the chart:
 
     helm delete my-wrongsecrets-ctf-party
+# wrongsecrets-ctf-party
 
-## Configuration
+![Version: 0.1.0-alpha](https://img.shields.io/badge/Version-0.1.0--alpha-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.5.9](https://img.shields.io/badge/AppVersion-1.5.9-informational?style=flat-square)
+
+Run Multi User "Capture the Flags" or Security Trainings with OWASP Wrongsecrets
+
+**Homepage:** <https://owasp.org/www-project-wrongsecrets/>
+
+## Source Code
+
+* <https://github.com/OWASP/wrongsecrets-ctf-party>
+
+## Values
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
@@ -175,3 +186,6 @@ To uninstall the chart:
 | wrongsecretsCleanup.successfulJobsHistoryLimit | int | `1` |  |
 | wrongsecretsCleanup.tag | float | `0.4` |  |
 | wrongsecretsCleanup.tolerations | list | `[]` | Optional Configure kubernetes toleration for the wrongsecretsCleanup Job (see: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.7.0](https://github.com/norwoodj/helm-docs/releases/v1.7.0)

helm/wrongsecrets-ctf-party/README.md.gotmpl

@@ -39,8 +39,3 @@ To install the wrongsecrets-ctf-party chart:
 To uninstall the chart:
 
     helm delete my-wrongsecrets-ctf-party
-
-
-## Configuration
-
-{{ template "chart.valuesTable" . }}