README
¶
Build
Yet another implementation of Makefile concept in go. Advantages over all the other available packages:
- go only, except small bash script
- no magic command discovery based on go source code, you explicitly declare paths and functions for your commands
- bash autocompletion supported
- set of standard commands
Example
Take a look at example/main.go
Compilation
This build system is written in pure go so you have to compile it
using go build before first usage. Take a look at the script I use in my setup.
I configure this script using alias feature delivered by bash in my ~/.bashrc:
alias projname="<path-to-project>/bin/builder"
Then you may execute:
$ projname <command> <command>
to execute commands.
Autocompletion
build supports autocompletion natively. To use it add this line to
your ~/.bashrc:
complete -o nospace -C projname projname
assuming you defined projname alias specified above.
Executing commands
Commands are organised in paths similar to the one in normal filesystem. Some examples how commands may be structured:
projname tools/apiClient
projname deploy/db
projname tests/backend/web-server
projname lint
You may specify many commands at once:
projname tests deploy
They are executed in specified order. This will save some time if both commands execute same dependencies.
Dependencies
Every command may specify dependencies - other commands which have to finish before the actual one may continue. It allows you to move some code common to many commands to another function.
If many commands require the same dependency, it is executed once.
Dependencies are executed one by one in order.
If circular dependency is detected error is raised.
Other features
List of commands
Execute
$ projname
to print available commands with their descriptions.
Verbose logging
If you want to see more logs during command execution, use -v or --verbose:
$ projname <command> -v
Errors
build always breaks on first failure.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Commands = map[string]types.Command{ "enter": { Description: "Enters the environment", Fn: enter, }, "build/me": { Description: "Rebuilds the builder", Fn: func(ctx context.Context, deps types.DepsFunc) error { return nil }, }, "tools/setup": { Description: "Installs all the tools for the host operating system", Fn: tools.EnsureAll, }, "tools/verify": { Description: "Verifies the checksums of all the tools", Fn: tools.VerifyChecksums, }, }
Commands is the list of standard commands useful for every environment.
Functions ¶
func EnsureTool ¶
EnsureTool ensures that tool exists, if not it is installed
func InstallTools ¶
InstallTools installs tools
func RegisterCommands ¶
RegisterCommands registers registeredCommands.
Types ¶
type Tool ¶
type Tool struct {
// Name is the name of the tool
Name string
// Version is the version of the tool
Version string
// IsGlobal instructs us to install the tool in global bin folder
IsGlobal bool
// URL is the url to the archive containing the tool
URL string
// Hash is the hash of the downloaded file
Hash string
// Binaries is the list of relative paths to binaries to install in local bin folder
Binaries map[string]string
}
Tool represents the tool to be required by the build system
Source Files
Directories