added pre-commit to ci to ensure docs are kept up-to-date

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

.github/workflows/lint-and-test.yaml

@@ -5,6 +5,31 @@ on:
     branches: [main]
 
 jobs:
+  pre-commit-check:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Install helm-docs
+        working-directory: /tmp
+        env:
+          HELM_DOCS_URL: https://github.com/norwoodj/helm-docs/releases/download/v1.5.0/helm-docs_1.5.0_Linux_x86_64.tar.gz
+        run: |
+          curl -LSs $HELM_DOCS_URL | tar xz && \
+          mv ./helm-docs /usr/local/bin/helm-docs && \
+          chmod +x /usr/local/bin/helm-docs && \
+          helm-docs --version
+
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Install pre-commit
+        run: pip install pre-commit
+
+      - uses: actions/checkout@v2
+
+      - name: run pre-commit
+        run: pre-commit run --all-files --show-diff-on-failure
+
   lint:
     runs-on: ubuntu-20.04
     container: quay.io/helmpack/chart-testing:v3.4.0
@@ -21,6 +46,7 @@ jobs:
     runs-on: ubuntu-20.04
     needs:
       - lint
+      - pre-commit-check
     steps:
       - name: Checkout
         uses: actions/checkout@v2

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/norwoodj/helm-docs
-    rev: v1.2.0
+    rev: v1.5.0
     hooks:
       - id: helm-docs
         args:

charts/ibm-fhir-server/README.md

@@ -1,5 +1,5 @@
 
-![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![AppVersion: 4.9.1](https://img.shields.io/badge/AppVersion-4.9.1-informational?style=flat-square) 
+![Version: 0.2.1](https://img.shields.io/badge/Version-0.2.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 4.9.1](https://img.shields.io/badge/AppVersion-4.9.1-informational?style=flat-square) 
 
 # The IBM FHIR Server Helm Chart
 
@@ -233,7 +233,7 @@ If the `objectStorage.objectStorageSecret` value is set, this helm chart will on
 | postgresql.image.tag | string | `"13.4.0-debian-10-r37"` | the tag for the postgresql image |
 | postgresql.postgresqlDatabase | string | `"fhir"` | name of the database to create. see: <https://github.com/bitnami/bitnami-docker-postgresql/blob/master/README.md#creating-a-database-on-first-run> |
 | postgresql.postgresqlExtendedConf | object | `{"maxPreparedTransactions":24}` | Extended Runtime Config Parameters (appended to main or default configuration) |
-| replicaCount | int | `2` | The number of replicas for the externally-facing FHIR server pods |
+| replicaCount | int | `1` | The number of replicas for the externally-facing FHIR server pods |
 | resources.limits.ephemeral-storage | string | `"1Gi"` |  |
 | resources.limits.memory | string | `"5Gi"` |  |
 | resources.requests.ephemeral-storage | string | `"1Gi"` |  |