Makefile

Import template repository

• Import via submodulebifrost-template, or just refer to

Custom makefile in the service

export BIFROST_DIR ?= ../../third_party/bifrost
export PROTO_DIR ?= ../protos-repo
export PROTOC_OPT ?= "-I../third_party"


export GEN_PROTO_GO_VALIDATE ?= true
export GEN_PROTO_GO_REST ?= true
export GEN_PROTO_GO_REST_GW ?= true
export GEN_PROTO_GO_AMQP ?= true
export GEN_PROTO_GO_VALIDATE_OPT ?= validate_enum=true
# export DEBUG ?= true

-include $(BIFROST_DIR)/Makefile_build


run_dev: ## Run service locally
	ASJARD_CONF_DIR="$(PWD)/conf $(PWD)/apis/api/conf"  go run -race ./apis/api

View help

make help

You will see a result similar to the following

Commands:
  run_dev      Run service locally
  build        Build
  gen_proto    Generate proto files
  clean_proto  Clean files generated from proto
  archive      Package
  install      Install
  restart      Restart
  start        Start
  stop         Stop
  uninstall    Uninstall
  run          Run locally, requires docker and docker-compose
  down         Local teardown, requires docker-compose
  test         Run test cases
  configure    Configure
  help         Usage help
Envs:
  BIFROST_DIR                Directory of the bifrost project, do not end with /                Default: .                      Current: ../../third_party/bifrost
  PROTO_DIR                  Directory of proto files, do not end with /                  Default: .                      Current: ../protos-repo
  PROTOC_OPT                 protoc command options                                 Default:                        Current: -I../third_party
  GEN_PROTO_GO               Whether to generate *.pb.go files from protobuf              Default: true                   Current: true
  GEN_PROTO_GO_OUT           Output directory for generated *.pb.go files                 Default: .                      Current: .
  GEN_PROTO_GO_OPT           Parameters required to generate *.pb.go                     Default:                        Current:
  GEN_PROTO_GO_GRPC          Whether to generate *_grpc.pb.go files from protobuf         Default: true                   Current: true
  GEN_PROTO_GO_GRPC_OPT      Parameters required to generate *_grpc.pb.go                  Default:                        Current:
  GEN_PROTO_GO_REST          Whether to generate *_rest.pb.go files from protobuf         Default: true                   Current: true
  GEN_PROTO_GO_REST_OPT      Parameters required to generate *_rest.pb.go                  Default:                        Current:
  GEN_PROTO_GO_REST_GW       Whether to generate *_rest_gw.pb.go files from protobuf      Default: true                   Current: true
  GEN_PROTO_GO_REST_GW_OPT   Parameters required to generate *_rest_gw.pb.go               Default:                        Current:
  GEN_PROTO_TS               Whether to generate *.d.tsx files from protobuf              Default: false                  Current: false
  GEN_PROTO_TS_OPT           Parameters required to generate *.d.tsx                      Default:                        Current:
  GEN_PROTO_TS_ENUM          Whether to generate *.enum.tsx files from protobuf           Default: false                  Current: false
  GEN_PROTO_TS_ENUM_OPT      Parameters required to generate *.enum.tsx                    Default:                        Current:
  GEN_PROTO_TS_UMI           Whether to generate *.umi.tsx files from protobuf            Default: fasle                  Current: fasle
  GEN_PROTO_TS_UMI_OPT       Parameters required to generate *.umi.tsx                    Default:                        Current:
  GEN_PROTO_TS_OUT           Output directory for generated *.pb.ts files                 Default: ./..                   Current: ./..
  GEN_PROTO_GO_ASYNQ         Whether to generate *_asynq.pb.go files from protobuf        Default: false                  Current: false
  GEN_PROTO_GO_ASYNQ_OPT     Parameters required to generate *_asynq.pb.go                 Default:                        Current:
  GEN_PROTO_GO_AMQP          Whether to generate *_amqp.pb.go files from protobuf         Default: false                  Current: true
  GEN_PROTO_GO_AMQP_OPT      Parameters required to generate *_amqp.pb.go                  Default:                        Current:
  GEN_PROTO_GO_VALIDATE      Whether to generate *_validate.pb.go files from protobuf     Default: true                   Current: true
  GEN_PROTO_GO_VALIDATE_OPT  Parameters for generating *_validate.pb.go files              Default:                        Current: validate_enum=true
  GOOS                       Runtime OS, options: linux,darwin,windows                  Default: linux                  Current: linux
  CGO_ENABLED                Whether to enable CGO, options: 0,1                          Default: 0                      Current: 0
  BUILD_DIR                  Build directory                                           Default: .                      Current: .
  DEBUG                      Whether to enable DEBUG                                    Default: false                  Current: false
  PROJECT_NAME               Project name                                              Default: bifrost                Current: bifrost
  DEPLOY_ENV                 Deployment environment, options: dev,sit,uat,pro           Default: dev                    Current: dev
  SERVICE_NAME               Service name                                              Default: bifrost                Current: bifrost
  VERSION                    Version number, default is the content of the version file in the current directory         Default: v0.0.1   Current: v0.0.1