make-rules

Make rules

Overall

Use ENV to control all Makefile rules. Implement all Makefile rules in shell scripts.

NOTE: All make rules are not dependent on the other rules.

• If you want to make container, you must make build firstly.
• If you want to make push, you must make container firstly.

A general use case is make build container push.

Prerequisite

• Place your project in $GOPATH
• Place make-rules under hack dir in your project

Install

As git submodule (recommended)

cd your/project
mkdir -p hack
cd hack && git submodule add https://github.com/zoumo/make-rules
cd make-rules && sh install.sh

Dir Convention

The build system follows the dir conventions:

├── bin
│   ├── darwin_amd64
│   └── linux_amd64
├── build
│   ├── server
│   └── worker
├── cmd
│   ├── server
│   └── worker
├── hack
│   └── make-rules
│       ├── lib
│       └── entrypoint
├── pkg
│   └── version
└── test

• bin contains build outputs, should be ignored in .gitignore.
  • ${GOOS}_${GOARCH} contains platform-based build outputs.
• build contains several directories must holding Dockerfile.
• cmd contains main packages, each subdirecoty of cmd is a main package.
• hack contains scripts used to manage this repository.
  • make-rules
    • lib contains scripts library.
    • make-rules contains scripts which implement Makefile rules.
• pkg/version contains version code to represent project's version. Version will be filled in during the compilation phase.

Help Message

All Makefile rules should print usage messages when ${HELP} == y

HELP=y make all

Color Log

COLOR_LOG=true make all

Version

The new version system based on git work tree status.

User defined version

VERSION=v0.0.4 make all

If your git repo contains changes not staged, a -dirty suffix will always be appended to final version.

Usage

Common

1. commit all staging changes, make the git tree clean.
2. use git tag add a new semantic version tag, e.g v0.0.3
3. the git version and docker tag will be v0.0.3

User defined version

1. VERSION=v0.0.4 make all
2. if you are working in a dirty git tree, the version will be v0.0.4-dirty
3. if you are working in a clea git tree, the version will be v0.0.4

Dirty

1. working in a dirty git tree, the latest tag is v0.0.2
2. no new commits
3. make build
4. the git version and docker tag will be v0.0.2-dirty

Commits Tracking

1. working in a clean git tree, the latest tag is v0.0.2
2. commit 1 new change
3. make build
4. the git version will be v0.0.2-1+1b4531e1acf800, the docker tag will be v0.0.2-1-1b4531e1acf800
5. that means since the latest tag, there is one new commit, and the latest commit id is 1b4531e1acf800

Go

Persistent Options:

Build

Supported rules:

• make all
• make $()
• make build
• make build-local
• make build-in-container

Other Options:

Usage:

# make all targets for all platforms
make all
make build

# make all targets for linux/amd64 
make all GO_BUILD_PLATFORMS=linux/amd64

# make cmd/server for linux/amd64
make all WHAT=cmd/server GO_BUILD_PLATFORMS=linux/amd64
make cmd/server GO_BUILD_PLATFORMS=linux/amd64

# make cmd/server for linux/amd64 in docker container
make build-in-container WHAT=cmd/server GO_BUILD_PLATFORMS=linux/amd64
LOCAL_BUILD=false make all WHAT=cmd/server GO_BUILD_PLATFORMS=linux/amd64
LOCAL_BUILD=false make cmd/server GO_BUILD_PLATFORMS=linux/amd64

# make cmd/server for linux/amd64 on local
make build-local WHAT=cmd/server GO_BUILD_PLATFORMS=linux/amd64
LOCAL_BUILD=true make build WHAT=cmd/server GO_BUILD_PLATFORMS=linux/amd64
LOCAL_BUILD=true make cmd/server GO_BUILD_PLATFORMS=linux/amd64

Test

Unit tetst

Supported rules:

• make unittest

Other options

Usage:

make unittest

E2E test

TODO

Container

Supported rules:

• make container
• make push

Options:

Usage:

# build all docker images
make container

# push all docker images
make push

# build and push build/server docker iamge
make container push WHAT=build/server