1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-03-19 20:57:53 +02:00

docs: update

Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>
This commit is contained in:
Carlos Alexandro Becker 2024-10-26 14:06:55 -03:00
parent 244bbf0afe
commit ca5ad8c5ed
No known key found for this signature in database
3 changed files with 43 additions and 9 deletions

View File

@ -44,6 +44,23 @@ dmg:
# will be built. # will be built.
extra_files: extra_files:
- logo.ico - logo.ico
- glob: ./docs/*.md
- glob: ./single_file.txt
# Templates: allowed.
# Note that this only works if glob matches exactly 1 file.
name_template: file.txt
# Additional templated extra files to add to the DMG.
# Those files will have their contents pass through the template engine,
# and its results will be added to the image as it would with the
# extra_files field above.
#
# Since: v2.4 (pro).
# Templates: allowed.
templated_extra_files:
- src: LICENSE.tpl
dst: LICENSE.txt
mode: 0644
# Whether to remove the archives from the artifact list. # Whether to remove the archives from the artifact list.
# If left as false, your end release will have both the archives and the # If left as false, your end release will have both the archives and the

View File

@ -241,11 +241,13 @@ uploads:
# Since: v2.1. # Since: v2.1.
extra_files: extra_files:
- glob: ./path/to/file.txt - glob: ./path/to/file.txt
- glob: ./docs/*.md
- glob: ./glob/**/to/**/file/**/* - glob: ./glob/**/to/**/file/**/*
- glob: ./glob/foo/to/bar/file/foobar/override_from_previous - glob: ./glob/foo/to/bar/file/foobar/override_from_previous
- glob: ./single_file.txt - glob: ./single_file.txt
# Templates: allowed. # Templates: allowed.
name_template: file.txt # note that this only works if glob matches 1 file only # Note that this only works if glob matches exactly 1 file.
name_template: file.txt
# Additional templated extra files to uploaded. # Additional templated extra files to uploaded.
# Those files will have their contents pass through the template engine, # Those files will have their contents pass through the template engine,

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

@ -1043,7 +1043,7 @@
}, },
"extra_files": { "extra_files": {
"items": { "items": {
"type": "string" "$ref": "#/$defs/ExtraFile"
}, },
"type": "array" "type": "array"
}, },
@ -1062,6 +1062,12 @@
"enum=binary", "enum=binary",
"appbundle" "appbundle"
] ]
},
"templated_extra_files": {
"items": {
"$ref": "#/$defs/TemplatedExtraFile"
},
"type": "array"
} }
}, },
"additionalProperties": false, "additionalProperties": false,
@ -1276,6 +1282,13 @@
"type": "object" "type": "object"
}, },
"ExtraFile": { "ExtraFile": {
"oneOf": [
{
"type": "string"
},
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://github.com/goreleaser/goreleaser/v2/pkg/config/file-alias",
"properties": { "properties": {
"glob": { "glob": {
"type": "string" "type": "string"
@ -1286,6 +1299,8 @@
}, },
"additionalProperties": false, "additionalProperties": false,
"type": "object" "type": "object"
}
]
}, },
"File": { "File": {
"oneOf": [ "oneOf": [