Stark Build System

This is a build system based on Makefiles that provides compilation and publishing capabilities focused on golang projects at Arquivei.

Requirements

• git
• GNU Make

Setup

Adds this repository as a submodule or download the files inside a directory. Using the submodule is the recommend way since it provides an auto-update target.

git submodule add --depth=1 https://github.com/arquivei/stark-build.git tooling/stark-build

NOTE: We use --depth=1 so we only download the last commit. You can remove this and download all files if you want to.

NOTE: You can also add a submodule using the git URL, but the problem with this approach is the you will need to setup proper ssh authentication:

git submodule add --depth=1 git@github.com:arquivei/stark-build.git tooling/stark-build

NOTE: The tooling sub-directory is just a suggestion that most projects follows.

Add the following snippet to your Makefile:

## Initializes or syncronizes stark build directory.
.PHONY: stark-build-sync
stark-build-sync:
	git submodule update --init --recursive tooling/stark-build/

-include tooling/stark-build/Makefile

For example, your Makefile could look like this:

# File: Makefile

# Initialize your makefile normally.
# ...

# Optionaly initialize any variables you would
# like to customize. For example:
GO_SWAGGER_GEN := API

# Enables stark-build
.PHONY: stark-build-sync
stark-build-sync:
	git submodule update --init --recursive tooling/stark-build/

-include tooling/stark-build/Makefile

# Other makefile targets for your project.

Then run in your terminal:

make stark-build-sync

Use this command as needed and inside CI/CD pipelines.

Usage

For information on variables and targets use the help target:

make help

The Makefiles contains comments and are relatively well structured. For extra information on default values, for example, you should check the files.

You can override most of the variables but they already come with some sane defaults. It is possible to use this project without any customization.

Architecture

The entry point of this project is the Makefile in the root directory. This should be the only file included by projects using stark-build.

All the features are provided by modules. Modules are directories inside modules/ directory which contains a Makefile. The module name is the directory. For example, modules/golang/Makefile denotes the golang module. The root Makefile is loaded, it includes the Makefile of each enabled module. If a module is split into multiple files, it's expected that the module's Makefile will take care of these includes.

Modules can be dynamically loaded. By default all modules are enabled and should work (at least not break any other module) out of the box. It means that variables should have sane defaults and error checks should be done inside targets.

Important bits should be documented to appears in the make help target. The help script uses ## to extract comments and build the help text. Use the existing documentation as example. Here is an example:

## #####################################
##
## Module: My module
##
## Some module description

## Some section

## Important variables should be documented
## Coments can be multiline
MY_VAR ?= sane default

## This documents a target
my-target:
    do stuff

Contributing

Fell free to post comments, open issues or pull-requests.