2017-12-13 18:14:01 +02:00
|
|
|
---
|
|
|
|
title: Signing
|
2018-04-25 07:20:12 +02:00
|
|
|
series: customization
|
|
|
|
hideFromIndex: true
|
|
|
|
weight: 60
|
2017-12-13 18:14:01 +02:00
|
|
|
---
|
|
|
|
|
|
|
|
GoReleaser can sign some or all of the generated artifacts. Signing ensures
|
|
|
|
that the artifacts have been generated by yourself and your users can verify
|
|
|
|
that by comparing the generated signature with your public signing key.
|
|
|
|
|
|
|
|
Signing works in combination with checksum files and it is generally sufficient
|
2017-12-13 23:57:24 +02:00
|
|
|
to sign the checksum files only.
|
2017-12-13 18:14:01 +02:00
|
|
|
|
|
|
|
The default is configured to create a detached signature for the checksum files
|
2017-12-20 12:32:21 +02:00
|
|
|
with [GnuPG](https://www.gnupg.org/) and your default key. To enable signing
|
2017-12-13 18:14:01 +02:00
|
|
|
just add
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
# goreleaser.yml
|
2019-07-21 23:46:46 +02:00
|
|
|
signs:
|
|
|
|
- artifacts: checksum
|
2017-12-13 18:14:01 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
To customize the signing pipeline you can use the following options:
|
|
|
|
|
|
|
|
```yml
|
|
|
|
# .goreleaser.yml
|
2019-07-21 23:46:46 +02:00
|
|
|
signs:
|
|
|
|
-
|
|
|
|
# name of the signature file.
|
|
|
|
# '${artifact}' is the path to the artifact that should be signed.
|
|
|
|
#
|
|
|
|
# defaults to `${artifact}.sig`
|
|
|
|
signature: "${artifact}_sig"
|
|
|
|
|
|
|
|
# path to the signature command
|
|
|
|
#
|
|
|
|
# defaults to `gpg`
|
|
|
|
cmd: gpg2
|
|
|
|
|
|
|
|
# command line arguments for the command
|
|
|
|
#
|
|
|
|
# to sign with a specific key use
|
|
|
|
# args: ["-u", "<key id, fingerprint, email, ...>", "--output", "${signature}", "--detach-sign", "${artifact}"]
|
|
|
|
#
|
|
|
|
# defaults to `["--output", "${signature}", "--detach-sign", "${artifact}"]`
|
|
|
|
args: ["--output", "${signature}", "${artifact}"]
|
|
|
|
|
|
|
|
|
|
|
|
# which artifacts to sign
|
|
|
|
#
|
|
|
|
# checksum: only checksum file(s)
|
|
|
|
# all: all artifacts
|
|
|
|
# none: no signing
|
|
|
|
#
|
|
|
|
# defaults to `none`
|
|
|
|
artifacts: all
|
2017-12-13 18:14:01 +02:00
|
|
|
```
|