Skip to content

Configuration

Nick Miyake edited this page Oct 17, 2017 · 2 revisions

Configuration

gödel projects are configured using YML files in the "godel/config" directory. The YML files in that directory specify the declarative configuration for various different aspects of gödel projects.

Overview

The following is a list of the supported configuration files. Refer to the struct definitions, tutorial steps or GoDocs for more information on the configuration values.

Example configuration for these files can usually be found on the tutorial page. Many of the config.go files also have example_test.go files in the same directory that contain example YML. Examining the equivalent files in other projects that use gödel (including gödel itself) is also a good way to get a sense of the configuration.

File Tasks Struct definitions Tutorial step
check.yml check, verify apps/okgo/config/config.go Check
dist.yml artifacts, build, dist, products, publish, run apps/distgo/config/config.go Dist
exclude.yml All config/config.go Exclude
format.yml format, verify apps/gonform/config/config.go Format
generate.yml generate, verify vendor/github.com/palantir/checks/gogenerate/config/config.go Generate
imports.yml imports, verify vendor/github.com/palantir/checks/gocd/config/config.go N/A
license.yml license, verify vendor/github.com/palantir/checks/golicense/config/config.go License
test.yml test, verify apps/gunit/config/config.go Test