1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-03-17 20:47:50 +02:00

docs: update docs

This commit is contained in:
Carlos Alexandro Becker 2024-04-01 10:26:09 -03:00
parent c9ca63ece7
commit fa431f313d
No known key found for this signature in database
5 changed files with 32 additions and 18 deletions

View File

@ -20,7 +20,7 @@ goreleaser build [flags]
## Options
```
--clean Remove the dist directory before building
--clean Removes the 'dist' directory before building
-f, --config string Load configuration from file
-h, --help help for build
--id stringArray Builds only the specified build ids

View File

@ -10,7 +10,7 @@ goreleaser release [flags]
```
--auto-snapshot Automatically sets --snapshot if the repository is dirty
--clean Removes the dist directory
--clean Removes the 'dist' directory
-f, --config string Load configuration from file
--fail-fast Whether to abort the release publishing on the first error
-h, --help help for release

View File

@ -19,22 +19,16 @@ You can also have plenty of customization options:
dockerhub:
- # Your docker.io username.
#
# Default: "{{ .Env.DOCKER_USERNAME }}"
# Templates: allowed
username: "{{ .Env.DOCKER_USERNAME }}"
# Disables the configuration feature in some conditions, for instance, when
# publishing patch releases.
# Any value different of 'true' will be considered 'false'.
#
# Templates: allowed
disable: "{{gt .Patch 0}}"
username: "john.doe"
# Environment variable name to get the push token from.
# You might want to change it if you have multiple dockerhub configurations.
#
# Templates: allowed
# Default: 'DOCKER_PASSWORD'
secret_name: MY_ACCOUNT_DOCKER_PASSWORD
# Default: "DOCKER_PASSWORD"
secret_name: DOCKER_TOKEN
# Images to apply the description and/or full description to.
#
@ -43,6 +37,13 @@ dockerhub:
- goreleaser/goreleaser
- goreleaser/goreleaser-pro
# Disables the configuration feature in some conditions, for instance, when
# publishing patch releases.
# Any value different of 'true' will be considered 'false'.
#
# Templates: allowed
disable: "{{gt .Patch 0}}"
# The short description of the image.
#
# Templates: allowed

23
www/docs/static/schema-pro.json generated vendored
View File

@ -217,7 +217,7 @@
}
]
},
"strip_parent_binary_folder": {
"strip_binary_directory": {
"type": "boolean"
},
"files": {
@ -251,6 +251,9 @@
}
],
"description": "you can now remove this"
},
"strip_parent_binary_folder": {
"type": "boolean"
}
},
"additionalProperties": false,
@ -291,7 +294,7 @@
"disable_ssl": {
"type": "boolean"
},
"folder": {
"directory": {
"type": "string"
},
"kms_key": {
@ -348,6 +351,9 @@
"type": "string",
"description": "use kms_key instead"
},
"folder": {
"type": "string"
},
"templated_extra_files": {
"items": {
"$ref": "#/$defs/TemplatedExtraFile"
@ -1241,7 +1247,8 @@
"gz",
"tar.xz",
"txz",
"binary"
"binary",
"none"
],
"default": "tar.gz"
}
@ -1424,7 +1431,7 @@
"commit_msg_template": {
"type": "string"
},
"folder": {
"directory": {
"type": "string"
},
"caveats": {
@ -1529,6 +1536,9 @@
"plist": {
"type": "string",
"description": "use service instead"
},
"folder": {
"type": "string"
}
},
"additionalProperties": false,
@ -3320,7 +3330,7 @@
"repository": {
"$ref": "#/$defs/RepoRef"
},
"folder": {
"directory": {
"type": "string"
},
"commit_author": {
@ -3398,6 +3408,9 @@
"bucket": {
"$ref": "#/$defs/RepoRef",
"description": "use repository instead"
},
"folder": {
"type": "string"
}
},
"additionalProperties": false,

View File

@ -111,7 +111,7 @@ Feel free to [add yours](https://github.com/goreleaser/goreleaser/edit/main/USER
Hey! Thanks for looking into this file!
If you're going to edit it, please:
- keep a-z ordering :)
- edit only the USERS.md file at the repository's root folder
- edit only the USERS.md file at the repository's root directory
- /www/docs/users.md is auto-copied from /USERS.md
-->