Modernize our Makefile

Brings the Makefile in line with our conventions on other projects.

Signed-off-by: Christopher Maier <[email protected]>

Author: christophermaier

Makefile

@@ -1,38 +1,53 @@
 DOCKER_COMPOSE_CHECK := docker compose run --rm
 
-# Linting
+.PHONY: all
+all: format
+all: lint
+all: test
+all: ## Run all operations
+
+.PHONY: help
+help: ## Print this help
+	@awk 'BEGIN {FS = ":.*##"; printf "Usage: make <target>\n"} \
+		 /^[a-zA-Z0-9_-]+:.*?##/ { printf "  %-46s %s\n", $$1, $$2 } \
+		 /^##@/ { printf "\n%s\n", substr($$0, 5) } ' \
+		 $(MAKEFILE_LIST)
+	@printf '\n'
+
+##@ Linting
 ########################################################################
 
 .PHONY: lint
-lint: lint-plugin lint-shell
+lint: lint-plugin
+lint: lint-shell
+lint: ## Perform lint checks on all files
 
 .PHONY: lint-plugin
-lint-plugin:
+lint-plugin: ## Lint the Buildkite plugin metadata
 	$(DOCKER_COMPOSE_CHECK) plugin-linter
 
 .PHONY: lint-shell
-lint-shell:
+lint-shell: ## Lint the shell scripts
 	./pants lint ::
 
-# Formatting
+##@ Formatting
 ########################################################################
 
 .PHONY: format
 format: format-shell
+format: ## Automatically format all code
 
 .PHONY: format-shell
-format-shell:
+format-shell: ## Format shell scripts
 	./pants fmt ::
 
-# Testing
+##@ Testing
 ########################################################################
 
 .PHONY: test
 test: test-plugin
+test: ## Run all tests
 
 .PHONY: test-plugin
-test-plugin:
+test-plugin: ## Test the Buildkite plugin locally (does *not* run a Buildkite pipeline)
 	$(DOCKER_COMPOSE_CHECK) plugin-tester
-
-.PHONY: all
-all: format lint test