You've already forked goreleaser
mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-09-16 09:26:52 +02:00
docs: update with jsonschema
This commit is contained in:
3
.gitattributes
vendored
3
.gitattributes
vendored
@@ -1,4 +1,4 @@
|
||||
* text eol=lf
|
||||
* text eol=lf
|
||||
|
||||
# Denote all files that are truly binary and should not be modified.
|
||||
*.png binary
|
||||
@@ -6,3 +6,4 @@
|
||||
*.ico binary
|
||||
|
||||
www/docs/static/schema.json linguist-generated=true
|
||||
www/docs/static/schema-pro.json linguist-generated=true
|
||||
|
@@ -28,5 +28,6 @@ single .goreleaser.yml file.
|
||||
* [goreleaser check](/cmd/goreleaser_check/) - Checks if configuration is valid
|
||||
* [goreleaser completion](/cmd/goreleaser_completion/) - generate the autocompletion script for the specified shell
|
||||
* [goreleaser init](/cmd/goreleaser_init/) - Generates a .goreleaser.yml file
|
||||
* [goreleaser jsonschema](/cmd/goreleaser_jsonschema/) - outputs goreleaser's JSON schema
|
||||
* [goreleaser release](/cmd/goreleaser_release/) - Releases the current project
|
||||
|
||||
|
25
www/docs/cmd/goreleaser_jsonschema.md
Normal file
25
www/docs/cmd/goreleaser_jsonschema.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# goreleaser jsonschema
|
||||
|
||||
outputs goreleaser's JSON schema
|
||||
|
||||
```
|
||||
goreleaser jsonschema [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for jsonschema
|
||||
-o, --output string where to save the json schema (default "-")
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug Enable debug mode
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
* [goreleaser](/cmd/goreleaser/) - Deliver Go binaries as fast and easily as possible
|
||||
|
@@ -5,3 +5,22 @@ GoReleaser can be customized by tweaking a `.goreleaser.yml` file.
|
||||
You can generate an example config by running [`goreleaser init`](/cmd/goreleaser_init/) or start from scratch.
|
||||
|
||||
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.
|
||||
|
||||
## JSON Schema
|
||||
|
||||
GoReleaser also has a [jsonschema][] file which you can use to have better editor support:
|
||||
|
||||
=== "OSS"
|
||||
```sh
|
||||
https://goreleaser.com/schema.json
|
||||
```
|
||||
|
||||
=== "Pro"
|
||||
```sh
|
||||
https://goreleaser.com/schema-pro.json
|
||||
```
|
||||
|
||||
You can also generate it for your specific version using the [`goreleaser jsonschema`][schema] command.
|
||||
|
||||
[jsonschema]: http://json-schema.org/draft/2020-12/json-schema-validation.html
|
||||
[schema]: /cmd/goreleaser_jsonschema/
|
||||
|
2263
www/docs/static/schema-pro.json
generated
vendored
Normal file
2263
www/docs/static/schema-pro.json
generated
vendored
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user