Writing a makefile for a golang project

by Golang Project preparation Makefile

| Golang

With the help of Makefile In the compilation process, we no longer need to manually input the compiled commands and compiled parameters every time , It can greatly simplify the project compilation process .

make Introduce

make Is a build automation tool , Will look for... In the current directory Makefile or makefile file . If the corresponding file exists , It will complete the construction task according to the defined rules .

Makefile Introduce

We can Makefile It simply defines the Compilation Rules of a project file . With the help of Makefile In the compilation process, we no longer need to manually input the compiled commands and compiled parameters every time , It can greatly simplify the project compilation process . Use at the same time Makefile You can also determine the specific Compilation Rules and processes in the project , Many open source projects define Makefile file .

This article will not cover in detail Makefile Various rules of , Only give Go In the project Makefile Example . About Makefile Recommended reading for details of Makefile course .

Rule overview

Makefile Composed of multiple rules , Each rule is mainly composed of two parts , They are dependency relations and commands executed .

Its structure is as follows ：

[target] ... : [prerequisites] ...
<tab>[command]
    ...
    ...

among ：

• targets： The goal of the rules
• prerequisites： Optional to generate targets The required files or targets .
• command：make Commands that need to be executed （ Any of the shell command ）. There can be multiple commands , Each command takes one line .

for instance ：

build:
	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o xx

Example

.PHONY: all build run gotool clean help

BINARY="bluebell"

all: gotool build

build:
	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o ${BINARY}

run:
	@go run ./

gotool:
	go fmt ./
	go vet ./

clean:
	@if [ -f ${BINARY} ] ; then rm ${BINARY} ; fi

help:
	@echo "make -  format  Go  Code ,  And compile and generate binary files "
	@echo "make build -  compile  Go  Code ,  Generate binaries "
	@echo "make run -  Direct operation  Go  Code "
	@echo "make clean -  Remove binaries and  vim swap files"
	@echo "make gotool -  function  Go  Tools  'fmt' and 'vet'"

among ：

• BINARY="bluebell" Is to define variables .
• .PHONY Used to define pseudo targets . Do not create target file , But to execute the commands under this goal .

---

Reference link ：https://www.liwenzhou.com/posts/Go/makefile/