2020-05-10 16:57:11 -03:00
|
|
|
# Customization
|
2017-09-10 17:07:28 -03:00
|
|
|
|
2021-12-23 01:52:01 +01:00
|
|
|
GoReleaser can be customized by tweaking a `.goreleaser.yaml` file.
|
2018-04-24 22:20:12 -07:00
|
|
|
|
2022-09-17 00:13:09 -03:00
|
|
|
You can generate an example config by running
|
|
|
|
[`goreleaser init`](/cmd/goreleaser_init/) or start from scratch.
|
2021-09-27 22:43:00 -03:00
|
|
|
|
2022-09-17 00:13:09 -03:00
|
|
|
You can also check if your config is valid by running
|
|
|
|
[`goreleaser check`](/cmd/goreleaser_check/), which will tell you if are using
|
|
|
|
deprecated or invalid options.
|
2021-10-26 15:15:26 -03:00
|
|
|
|
|
|
|
## JSON Schema
|
|
|
|
|
2022-09-17 00:13:09 -03:00
|
|
|
GoReleaser also has a [jsonschema][] file, which you can use to have better
|
|
|
|
editor support:
|
2021-10-26 15:15:26 -03:00
|
|
|
|
|
|
|
=== "OSS"
|
|
|
|
```sh
|
2021-10-29 14:03:29 -03:00
|
|
|
https://goreleaser.com/static/schema.json
|
2021-10-26 15:15:26 -03:00
|
|
|
```
|
|
|
|
|
2022-09-15 09:41:26 -03:00
|
|
|
You can also specify it in your `.goreleaser.yml` config file by adding a
|
|
|
|
comment like the following:
|
|
|
|
```yaml
|
|
|
|
# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
|
|
|
|
```
|
|
|
|
|
2021-10-26 15:15:26 -03:00
|
|
|
=== "Pro"
|
|
|
|
```sh
|
2021-10-29 14:03:29 -03:00
|
|
|
https://goreleaser.com/static/schema-pro.json
|
2021-10-26 15:15:26 -03:00
|
|
|
```
|
|
|
|
|
2022-09-15 09:41:26 -03:00
|
|
|
You can also specify it in your `.goreleaser.yml` config file by adding a
|
|
|
|
comment like the following:
|
|
|
|
```yaml
|
|
|
|
# yaml-language-server: $schema=https://goreleaser.com/static/schema-pro.json
|
|
|
|
```
|
|
|
|
|
2022-09-17 00:13:09 -03:00
|
|
|
You can also generate it for your specific version using the
|
|
|
|
[`goreleaser jsonschema`][schema] command.
|
2021-10-26 15:15:26 -03:00
|
|
|
|
2022-11-02 22:14:25 -03:00
|
|
|
### Pin the schema version
|
|
|
|
|
|
|
|
You can pin the version by getting the schema from the GitHub tag, for example,
|
|
|
|
for v1.12.0:
|
|
|
|
|
|
|
|
|
|
|
|
=== "OSS"
|
|
|
|
```sh
|
|
|
|
https://raw.githubusercontent.com/goreleaser/goreleaser/v1.12.0/www/docs/static/schema.json
|
|
|
|
```
|
|
|
|
|
|
|
|
=== "Pro"
|
|
|
|
```sh
|
|
|
|
https://raw.githubusercontent.com/goreleaser/goreleaser/v1.12.0/www/docs/static/schema-pro.json
|
|
|
|
```
|
|
|
|
|
2021-10-26 15:15:26 -03:00
|
|
|
[jsonschema]: http://json-schema.org/draft/2020-12/json-schema-validation.html
|
|
|
|
[schema]: /cmd/goreleaser_jsonschema/
|