1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-26 04:22:05 +02:00

63 lines
1.6 KiB
Markdown
Raw Normal View History

# Introduction
2017-09-10 17:07:28 -03:00
GoReleaser can be customized by tweaking a `.goreleaser.yaml` file.
You can generate an example config by running
[`goreleaser init`](../cmd/goreleaser_init.md) or start from scratch.
You can also check if your config is valid by running
[`goreleaser check`](../cmd/goreleaser_check.md), which will tell you if are
using deprecated or invalid options.
2021-10-26 15:15:26 -03:00
## JSON Schema
GoReleaser also has a [jsonschema][] file, which you can use to have better
editor support:
2021-10-26 15:15:26 -03:00
=== "OSS"
2023-09-29 00:49:02 +00:00
2021-10-26 15:15:26 -03:00
```sh
2021-10-29 14:03:29 -03:00
https://goreleaser.com/static/schema.json
2021-10-26 15:15: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"
2023-09-29 00:49:02 +00:00
2021-10-26 15:15:26 -03:00
```sh
2021-10-29 14:03:29 -03:00
https://goreleaser.com/static/schema-pro.json
2021-10-26 15:15: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
```
You can also generate it for your specific version using the
[`goreleaser jsonschema`][schema] command.
2021-10-26 15:15:26 -03:00
### Pin the schema version
You can pin the version by getting the schema from the GitHub tag, for example,
for `__VERSION__` (latest):
=== "OSS"
2023-09-29 00:49:02 +00:00
```sh
https://raw.githubusercontent.com/goreleaser/goreleaser/__VERSION__/www/docs/static/schema.json
```
=== "Pro"
2023-09-29 00:49:02 +00:00
```sh
https://raw.githubusercontent.com/goreleaser/goreleaser/__VERSION__/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.md