From 56ecc03341f2af439d108306ac7dc0f5e3faadc1 Mon Sep 17 00:00:00 2001
From: Hector <hector@hjs.dev>
Date: Wed, 21 Jun 2023 15:02:11 +0000
Subject: [PATCH] chore: update makefile commands (!92)

* Tweak makefile commands and file formatting
* Remove command and build step for go mod formatting
* Add command to update project dependencies
* Add make command to list all make commands

https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/-/merge_requests/92
---
 .gitlab-ci.yml |  6 ------
 Makefile       | 29 ++++++++++++++++++++++++-----
 2 files changed, 24 insertions(+), 11 deletions(-)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index ab44653..a6423c6 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -12,12 +12,6 @@ sast:
 include:
 - template: Security/SAST.gitlab-ci.yml
 
-dependencies:
-  extends: .go_template
-  stage: test
-  script:
-    - make check/dependencies
-
 format:
   extends: .go_template
   stage: test
diff --git a/Makefile b/Makefile
index 702a3ff..e3a6ae6 100644
--- a/Makefile
+++ b/Makefile
@@ -1,21 +1,38 @@
-.PHONY: download test fmt check/dependencies check/fmt build build/docker
+# List make commands
+.PHONY: ls
+ls:
+	cat Makefile | grep "^[a-zA-Z#].*" | cut -d ":" -f 1 | sed s';#;\n#;'g
 
+# Download dependencies
+.PHONY: download
 download:
 	go mod download
 
+# Update project dependencies
+.PHONY: update
+update:
+	go get -u
+	go mod download
+	go mod tidy
+
+# Run project tests
+.PHONY: test
 test: download
 	go test ./... -v -race
 
+# Format code
+.PHONY: fmt
 fmt: download
+	go mod tidy
 	go fmt ./...
 
-check/dependencies: download
-	go mod tidy -v
-	git diff-index --quiet HEAD
-
+# Check for unformatted go code
+.PHONY: check/fmt
 check/fmt: download
 	test -z $(shell gofmt -l .)
 
+# Build project
+.PHONY: build
 build:
 	go build \
 	-ldflags "\
@@ -27,5 +44,7 @@ build:
 	-o fail2ban_exporter \
 	exporter.go
 
+# Build project docker container
+.PHONY: build/docker
 build/docker: build
 	docker build -t fail2ban-prometheus-exporter .