github.com/jonsyu1/godel@v0.0.0-20171017211503-64567a0cf169/docs/Configuration.md (about)

     1  Configuration
     2  =============
     3  gödel projects are configured using YML files in the "godel/config" directory. The YML files in that directory specify
     4  the declarative configuration for various different aspects of gödel projects.
     5  
     6  Overview
     7  --------
     8  
     9  The following is a list of the supported configuration files. Refer to the struct definitions, tutorial steps or GoDocs
    10  for more information on the configuration values.
    11  
    12  Example configuration for these files can usually be found on the tutorial page. Many of the `config.go` files also
    13  have `example_test.go` files in the same directory that contain example YML. Examining the equivalent files in other
    14  projects that use gödel (including gödel itself) is also a good way to get a sense of the configuration.
    15  
    16  | File | Tasks | Struct definitions | Tutorial step |
    17  | ---- | ----- | ------------------ | ------------- |
    18  | `check.yml` | `check`, `verify` | [apps/okgo/config/config.go](https://github.com/palantir/godel/blob/master/apps/okgo/config/config.go) | [Check](https://github.com/palantir/godel/wiki/Check) |
    19  | `dist.yml`  | `artifacts`, `build`, `dist`, `products`, `publish`, `run` | [apps/distgo/config/config.go](https://github.com/palantir/godel/blob/master/apps/distgo/config/config.go) | [Dist](https://github.com/palantir/godel/wiki/Dist) |
    20  | `exclude.yml` | All | [config/config.go](https://github.com/palantir/godel/blob/master/config/config.go) | [Exclude](https://github.com/palantir/godel/wiki/Exclude) |
    21  | `format.yml` | `format`, `verify` | [apps/gonform/config/config.go](https://github.com/palantir/godel/blob/master/apps/gonform/config/config.go) | [Format](https://github.com/palantir/godel/wiki/Format) |
    22  | `generate.yml` | `generate`, `verify` | [vendor/github.com/palantir/checks/gogenerate/config/config.go](https://github.com/palantir/godel/blob/master/vendor/github.com/palantir/checks/gogenerate/config/config.go) | [Generate](https://github.com/palantir/godel/wiki/Generate) |
    23  | `imports.yml` | `imports`, `verify` | [vendor/github.com/palantir/checks/gocd/config/config.go](https://github.com/palantir/godel/blob/master/vendor/github.com/palantir/checks/gocd/config/config.go) | N/A |
    24  | `license.yml` | `license`, `verify` | [vendor/github.com/palantir/checks/golicense/config/config.go](https://github.com/palantir/godel/blob/master/vendor/github.com/palantir/checks/golicense/config/config.go) | [License](https://github.com/palantir/godel/wiki/License-headers) |
    25  | `test.yml` | `test`, `verify` | [apps/gunit/config/config.go](https://github.com/palantir/godel/blob/master/apps/gunit/config/config.go) | [Test](https://github.com/palantir/godel/wiki/Test) |