fix: Add verify-fmt and fmt, fail PR if not formatted

This is a first attempt to solve some of the problems we get hit with relating to merging `jenkins-x.yml`, mandating that `jenkins-x.yml` is consistently formatted (by using a little utility I wrote that reads in the file and outputs it again via marshalling with `sigs.k8s.io/yaml`). Signed-off-by: Andrew Bayer <[email protected]>
jenkins-x · Nov 5, 2019 · 84ba05b · 84ba05b
1 parent 37df9b2
commit 84ba05b
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,20 @@
+GO := GO111MODULE=off go
+
+install-fmt-deps:
+	$(GO) get github.com/abayer/fmt-yml-for-k8s
+
+fmt: install-fmt-deps
+	${GOPATH}/bin/fmt-yml-for-k8s --file jenkins-x.yml --output-dir .
+
+verify-fmt: install-fmt-deps fmt
+	$(eval CHANGED = $(shell git ls-files --modified --exclude-standard))
+	@if [ "$(CHANGED)" == "" ]; \
+		then \
+			echo "jenkins-x.yml properly formatted"; \
+		else \
+			echo "jenkins-x.yml is not properly formatted"; \
+			echo "$(CHANGED)"; \
+			git diff; \
+			exit 1; \
+		fi
+
diff --git a/jenkins-x-bdd-local.yml b/jenkins-x-bdd-local.yml
@@ -46,6 +46,8 @@ pipelineConfig:
                   - mountPath: /secrets
                     name: sa
             steps:
+              - name: verify-fmt
+                command: make verify-fmt
               - name: run-bdd
                 command: bdd/bdd.sh
                 args: ['bdd/boot-local', 'bdd-config']