From 2f9156cf342137808d483cf3d4623cc8f288f330 Mon Sep 17 00:00:00 2001
From: Daniel Farrell <dfarrell@redhat.com>
Date: Fri, 2 Jul 2021 07:41:09 -0400
Subject: [PATCH] Extract helm-docs generation/testing to Makefile

Signed-off-by: Daniel Farrell <dfarrell@redhat.com>
---
 .github/workflows/linting.yml | 15 +--------------
 Makefile                      | 17 ++++++++++++++++-
 2 files changed, 17 insertions(+), 15 deletions(-)

diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml
index 4172588..d4a9b27 100644
--- a/.github/workflows/linting.yml
+++ b/.github/workflows/linting.yml
@@ -65,20 +65,7 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Run helm-docs and verify docs are up-to-date
-        run: |
-          HELM_DOCS_VERSION="0.15.0"
-          # Avoid polluting repo with helm-docs' README/LICENSE or other files in the release archive
-          cd /tmp
-          curl -sL "https://github.com/norwoodj/helm-docs/releases/download/v${HELM_DOCS_VERSION}/helm-docs_${HELM_DOCS_VERSION}_Linux_x86_64.tar.gz" | tar zx
-          cd -
-          /tmp/helm-docs
-          if [[ ! -z "$(git status --porcelain)" ]]; then
-            echo "Helm docs not up-to-date:"
-            git status --porcelain
-            git diff
-            echo "Run helm-docs, as the CI does above, and commit the updated docs."
-            exit 1
-          fi
+        run: make helm-docs
 
   markdown-link-check:
     name: Markdown Links (modified files)
diff --git a/Makefile b/Makefile
index 40d4c84..1a80882 100644
--- a/Makefile
+++ b/Makefile
@@ -22,6 +22,7 @@ export DEPLOY_ARGS
 GH_URL=https://submariner-io.github.io/submariner-charts/charts
 CHARTS_DIR=charts
 CHARTS_VERSION=0.7.0
+HELM_DOCS_VERSION=0.15.0
 REPO_URL=$(shell git config remote.origin.url)
 
 # Process extra flags from the `using=a,b,c` optional flag
@@ -42,6 +43,20 @@ e2e: E2E_ARGS=cluster1 cluster2
 	helm dep update $(subst -$(CHARTS_VERSION),,$(basename $(@F)))
 	helm package --version $(CHARTS_VERSION) $(subst -$(CHARTS_VERSION),,$(basename $(@F)))
 
+helm-docs:
+	# Avoid polluting repo with helm-docs' README/LICENSE or other files in the release archive
+	cd /tmp && \
+	curl -sL https://github.com/norwoodj/helm-docs/releases/download/v$(HELM_DOCS_VERSION)/helm-docs_$(HELM_DOCS_VERSION)_Linux_x86_64.tar.gz | tar zx && \
+	cd -
+	/tmp/helm-docs
+	if [ ! -z $(git status --porcelain) ]; then \
+		echo "Helm docs not up-to-date:"; \
+		git status --porcelain; \
+		git diff; \
+		echo "Run make helm-docs locally to generate updated docs, commit the updates."; \
+		exit 1; \
+	fi
+
 release: submariner-k8s-broker-$(CHARTS_VERSION).tgz submariner-operator-$(CHARTS_VERSION).tgz
 	git checkout gh-pages
 	mv *.tgz $(CHARTS_DIR)
@@ -51,7 +66,7 @@ release: submariner-k8s-broker-$(CHARTS_VERSION).tgz submariner-operator-$(CHART
 	  helm repo index $(CHARTS_DIR) --url $(GH_URL); \
 	fi
 
-.PHONY: release
+.PHONY: release helm-docs
 
 else