/build-tools

Development and CI build scripts

Primary LanguageMakefileMIT LicenseMIT

Build Tools

This project contains common make build scripts that are used by my projects. The idea is to reduce the Makefile copypaste from one project to another, standardize the codebase, and speed the development of a new project.

In the future, I would like to put more logic in these makefiles to implement more versatility and some more check, for now, they are a little rough.

Prerequisites

Other prerequisites can be found under each folder, check the README.md before include them. For sure Docker is a must since I will use containers every time I can.

Configure

To use this build project just add a submodule to your project:

git submodule add https://github.com/giglium/build-tools build-tools

and add a Makefile in the root folder.

An example of a minimal configuration is:

# ====================================================================================
# Setup Project

include ./build/common.mk

# ====================================================================================
# Actions

.PHONY: all
all:  help

.PHONY: test
test: ; @:

.PHONY: clean
clean: ; @:

After that, you can include all the *.mk files to enable the out-of-the-box command.

Version

For now, is impossible to use a tag on submodules. For this reason, I will create a branch with a pattern like v0.0.1 every time I introduce a breaking change. This branches will not be maintained, but they will give you enough time to migrate to the main version. So get a look every time you update the submodules! I will also create releases where I will put all the info necessary to align to the main branch.

License

MIT License