1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2024-12-27 01:33:39 +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-16 01:22:12 -03:00
parent 724d4ae90d
commit 248c7fcb5f
No known key found for this signature in database
5 changed files with 115 additions and 0 deletions

1
.gitattributes vendored
View File

@ -4,6 +4,7 @@
*.png binary
*.jpg binary
*.ico binary
*.icns binary
www/docs/static/schema.json linguist-generated=true
www/docs/static/schema-pro.json linguist-generated=true

View File

@ -0,0 +1,66 @@
# App Bundles
<!-- md:pro -->
<!-- md:version v2.4 -->
GoReleaser can create macOS App Bundles (a.k.a. `.app` files).
The `app_bundles` section specifies how the images should be created:
```yaml
# .goreleaser.yaml
app_bundles:
- # ID of the resulting image.
#
# Default: the project name.
id: foo
# Filename of the image (without the extension).
#
# Default: '{{.ProjectName}}'.
# Templates: allowed.
name: "myproject"
# IDs of the archives to use.
# Empty means all IDs.
ids:
- foo
- bar
# Allows to further filter the artifacts.
#
# Artifacts that do not match this expression will be ignored.
#
# Templates: allowed.
if: '{{ eq .Os "linux" }}'
# More files that will be available in the context in which the image
# will be built.
extra_files:
- README.md
# Icon file to use in the app.
# Must be a `icns` file.
#
# Templates: allowed.
icon: ./static/myapp.icns
# App bundle name.
#
# Templates: allowed.
bundle: com.example.myapp
# Set the modified timestamp on the output image, typically
# you would do this to ensure a build was reproducible. Pass an
# empty string to skip modifying the output.
#
# Templates: allowed.
mod_timestamp: "{{ .CommitTimestamp }}"
```
## Limitations
1. As of v2.4, App Bundles can only be used together with [DMGs](dmg.md). This
might change in the future.
<!-- md:templates -->

BIN
www/docs/static/goreleaser.icns vendored Normal file

Binary file not shown.

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

@ -173,6 +173,40 @@
"additionalProperties": false,
"type": "object"
},
"AppBundle": {
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"ids": {
"items": {
"type": "string"
},
"type": "array"
},
"if": {
"type": "string"
},
"mod_timestamp": {
"type": "string"
},
"icon": {
"type": "string"
},
"bundle": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"icon",
"bundle"
]
},
"Archive": {
"properties": {
"id": {
@ -1021,6 +1055,13 @@
},
"if": {
"type": "string"
},
"use": {
"type": "string",
"enum": [
"enum=binary",
"appbundle"
]
}
},
"additionalProperties": false,
@ -2986,6 +3027,12 @@
},
"type": "array"
},
"app_bundles": {
"items": {
"$ref": "#/$defs/AppBundle"
},
"type": "array"
},
"dmg": {
"items": {
"$ref": "#/$defs/DMG"

View File

@ -119,6 +119,7 @@ nav:
- customization/archive.md
- customization/source.md
- Linux Packages: customization/nfpm.md
- customization/app_bundles.md
- customization/dmg.md
- customization/msi.md
- customization/checksum.md