mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-01-10 03:47:03 +02:00
c457d8fff7
* feat: allow to use .Path and .Name on universal binary post hooks
This allows the usage of `{{ .Path }}` and `{{ .Name }}` on post
templates.
Closes #2890
* docs: improve docs
* test: add more tests
96 lines
2.6 KiB
Markdown
96 lines
2.6 KiB
Markdown
# macOS Universal Binaries
|
|
|
|
GoReleaser can create _macOS Universal Binaries_ - also known as _Fat Binaries_.
|
|
Those binaries are in a special format that contains both `arm64` and `amd64` executables in a single file.
|
|
|
|
Here's how to use it:
|
|
|
|
```yaml
|
|
# .goreleaser.yaml
|
|
universal_binaries:
|
|
-
|
|
# ID of resulting universal binary.
|
|
#
|
|
# Defaults to the project name.
|
|
id: foo
|
|
|
|
# IDs to use to filter the built binaries.
|
|
#
|
|
# Defaults to the `id` field.
|
|
ids:
|
|
- build1
|
|
- build2
|
|
|
|
# Universal binary name template.
|
|
#
|
|
# You will want to change this if you have multiple builds!
|
|
#
|
|
# Defaults to '{{ .ProjectName }}'
|
|
name_template: '{{.ProjectName}}_{{.Version}}'
|
|
|
|
# Whether to remove the previous single-arch binaries from the artifact list.
|
|
# If left as false, your end release might have both several macOS archives: amd64, arm64 and all.
|
|
#
|
|
# Defaults to false.
|
|
replace: true
|
|
|
|
# Hooks can be used to customize the final binary,
|
|
# for example, to run generators.
|
|
# Those fields allow templates.
|
|
#
|
|
# Default is both hooks empty.
|
|
hooks:
|
|
pre: rice embed-go
|
|
post: ./script.sh {{ .Path }}
|
|
```
|
|
|
|
!!! tip
|
|
Learn more about the [name template engine](/customization/templates/).
|
|
|
|
For more info about hooks, see the [build section](/customization/build/#build-hooks).
|
|
|
|
The minimal configuration for most setups would look like this:
|
|
```yaml
|
|
# .goreleaser.yml
|
|
universal_binaries:
|
|
- replace: true
|
|
```
|
|
|
|
That config will join your default build macOS binaries into an Universal Binary,
|
|
removing the single-arch binaries from the artifact list.
|
|
|
|
From there, the `Arch` template variable for this file will be `all`.
|
|
You can use the Go template engine to remove it if you'd like.
|
|
|
|
!!! warning
|
|
You'll want to change `name_template` for each `id` you add in universal binaries, otherwise they'll have the same name.
|
|
|
|
Example:
|
|
|
|
```yaml
|
|
universal_binaries:
|
|
- id: foo
|
|
name_template: bin1
|
|
- id: bar
|
|
name_template: bin2
|
|
```
|
|
|
|
## Naming templates
|
|
|
|
Most fields that support [templating](/customization/templates/) will also
|
|
support the following build details:
|
|
|
|
| Key | Description |
|
|
|---------|-----------------------------------|
|
|
| .Os | `GOOS`, always `darwin` |
|
|
| .Arch | `GOARCH`, always `all` |
|
|
| .Arm | `GOARM`, always empty |
|
|
| .Ext | Extension, always empty |
|
|
| .Target | Build target, always `darwin_all` |
|
|
| .Path | The binary path |
|
|
| .Name | The binary name |
|
|
|
|
!!! tip
|
|
Notice that `.Path` and `.Name` will only be available after they are
|
|
evaluated, so they are mostly only useful in the `post` hooks.
|