gödel =====
gödel is a Go build tool that provides tasks for configuring, formatting, checking, testing, building and publishing Go projects in a declarative, consistent and reproducible manner across different platforms and environments. gödel can be used in both local development environments and for verifying the correctness of project in CI environments. gödel uses declarative configuration to define the parameters for a project and provides an executable that orchestrates build tasks using standard Go commands. It centralizes project configuration and eliminates the need for custom build scripts that conflate configuration with logic. gödel is designed to be portable, fast and lightweight -- adding it to a project consists of copying a single file and directory into the project and adds less than 50kb of version-controlled material.
gödel is also highly extensible and configurable. The core functionality of gödel is provided by plugins and assets, and it is easy to write new plugins or assets and to configure a gödel instance to use custom plugins or assets as needed.
Features -------- The following features are provided by a default gödel installation (either as builtin tasks or default plugin tasks):
- Add to a project by running the
godelinitprogram ./godelw git-hooksinstalls Git commit hook that formats files on commit./godelw golandcreates and configures a GoLand project for the project- Supports configuring directories and files that should be excluded by the tool
./godelw formatformats all code in a project./godelw lintruns a variety of code linting checks on all the code in a project
golangci-lint to run linters
* The golangci-lint executable that should be used (which can be one that is built with custom linters) can be
configured as an asset
./godelw licenseapplies a specified license header to all Go files in a project
./godelw testruns the tests in the project
./godelw buildbuilds executables formainpackages in the project
ldflag for version and other variables
* Installs packages by default to speed up repeated builds
./godelw distcreates distribution files for products
tgz distributions
* Supports customizing creation of distribution using scripts
* Supports creating custom distributions using assets
./godelw publishpublishes artifacts to Bintray, Artifactory or GitHub
palantir/godel/pkg/productspackage provides a mechanism to easily write integration tests for gödel projects
./godelw updateupdates gödel to the version specified ingodel/config/godel.properties./godelw verifyruns all of the tasks that declare support for verification
./godelw github-wikimirrors a documents directory to a GitHub Wiki repository
./godelw --help for a list of all of the available commands. Furthermore, custom
Documentation
-------------
Documentation for this project is in the docs directory and the GitHub Wiki
(the GitHub Wiki mirrors the contents of the docs directory).
License ------- This project is made available under the Apache 2.0 License.