Last active
May 18, 2024 13:56
-
-
Save alexedwards/3b40775846535d0014ab1ff477e4a568 to your computer and use it in GitHub Desktop.
Boilerplate Makefile for Go projects
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Change these variables as necessary. | |
| MAIN_PACKAGE_PATH := ./cmd/example | |
| BINARY_NAME := example | |
| # ==================================================================================== # | |
| # HELPERS | |
| # ==================================================================================== # | |
| ## help: print this help message | |
| .PHONY: help | |
| help: | |
| @echo 'Usage:' | |
| @sed -n 's/^##//p' ${MAKEFILE_LIST} | column -t -s ':' | sed -e 's/^/ /' | |
| .PHONY: confirm | |
| confirm: | |
| @echo -n 'Are you sure? [y/N] ' && read ans && [ $${ans:-N} = y ] | |
| .PHONY: no-dirty | |
| no-dirty: | |
| git diff --exit-code | |
| # ==================================================================================== # | |
| # QUALITY CONTROL | |
| # ==================================================================================== # | |
| ## tidy: format code and tidy modfile | |
| .PHONY: tidy | |
| tidy: | |
| go fmt ./... | |
| go mod tidy -v | |
| ## audit: run quality control checks | |
| .PHONY: audit | |
| audit: | |
| go mod verify | |
| go vet ./... | |
| go run honnef.co/go/tools/cmd/staticcheck@latest -checks=all,-ST1000,-U1000 ./... | |
| go run golang.org/x/vuln/cmd/govulncheck@latest ./... | |
| go test -race -buildvcs -vet=off ./... | |
| # ==================================================================================== # | |
| # DEVELOPMENT | |
| # ==================================================================================== # | |
| ## test: run all tests | |
| .PHONY: test | |
| test: | |
| go test -v -race -buildvcs ./... | |
| ## test/cover: run all tests and display coverage | |
| .PHONY: test/cover | |
| test/cover: | |
| go test -v -race -buildvcs -coverprofile=/tmp/coverage.out ./... | |
| go tool cover -html=/tmp/coverage.out | |
| ## build: build the application | |
| .PHONY: build | |
| build: | |
| # Include additional build steps, like TypeScript, SCSS or Tailwind compilation here... | |
| go build -o=/tmp/bin/${BINARY_NAME} ${MAIN_PACKAGE_PATH} | |
| ## run: run the application | |
| .PHONY: run | |
| run: build | |
| /tmp/bin/${BINARY_NAME} | |
| ## run/live: run the application with reloading on file changes | |
| .PHONY: run/live | |
| run/live: | |
| go run github.com/cosmtrek/air@v1.43.0 \ | |
| --build.cmd "make build" --build.bin "/tmp/bin/${BINARY_NAME}" --build.delay "100" \ | |
| --build.exclude_dir "" \ | |
| --build.include_ext "go, tpl, tmpl, html, css, scss, js, ts, sql, jpeg, jpg, gif, png, bmp, svg, webp, ico" \ | |
| --misc.clean_on_exit "true" | |
| # ==================================================================================== # | |
| # OPERATIONS | |
| # ==================================================================================== # | |
| ## push: push changes to the remote Git repository | |
| .PHONY: push | |
| push: tidy audit no-dirty | |
| git push | |
| ## production/deploy: deploy the application to production | |
| .PHONY: production/deploy | |
| production/deploy: confirm tidy audit no-dirty | |
| GOOS=linux GOARCH=amd64 go build -ldflags='-s' -o=/tmp/bin/linux_amd64/${BINARY_NAME} ${MAIN_PACKAGE_PATH} | |
| upx -5 /tmp/bin/linux_amd64/${BINARY_NAME} | |
| # Include additional deployment steps here... | |
@megasuperlexa why not? make is almost ubiquitous, it's a good starting point IMHO!
Nice little project, may I suggest to add a license to this?
@graugans Consider it published under the MIT license.
so useful
very useful!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
so all targets are phony, what is the point of using
makein this case? maybe just use plain bash?