mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-02-09 13:36:56 +02:00
d524d93086
- [x] if the default is the zero-value for the field, do not specify - [ ] TODO: add a "how to read this docs" section somewhere explaining that - [x] if the change was introduced in a v1.x.0, say only v1.x - [x] drop trail ending `.` from Since, Default, etc - [x] wording: always use `Default: ` instead of `Defaults to` and others - [x] add a note to templateable fields - [x] default value of a field, if its a string, always between single quotes `'` --------- Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
62 lines
1.8 KiB
Markdown
62 lines
1.8 KiB
Markdown
# Checksums
|
|
|
|
GoReleaser generates a `project_1.0.0_checksums.txt` file and uploads it with the
|
|
release, so your users can validate if the downloaded files are correct.
|
|
|
|
The `checksum` section allows customizations of the filename:
|
|
|
|
```yaml
|
|
# .goreleaser.yaml
|
|
checksum:
|
|
# You can change the name of the checksums file.
|
|
#
|
|
# Default: {{ .ProjectName }}_{{ .Version }}_checksums.txt
|
|
# Templates: allowed
|
|
name_template: "{{ .ProjectName }}_checksums.txt"
|
|
|
|
# Algorithm to be used.
|
|
# Accepted options are sha256, sha512, sha1, crc32, md5, sha224 and sha384.
|
|
#
|
|
# Default: sha256.
|
|
algorithm: sha256
|
|
|
|
# IDs of artifacts to include in the checksums file.
|
|
#
|
|
# If left empty, all published binaries, archives, linux packages and source archives
|
|
# are included in the checksums file.
|
|
ids:
|
|
- foo
|
|
- bar
|
|
|
|
# Disable the generation/upload of the checksum file.
|
|
disable: true
|
|
|
|
# You can add extra pre-existing files to the checksums file.
|
|
# The filename on the checksum will be the last part of the path (base).
|
|
# If another file with the same name exists, the last one found will be used.
|
|
#
|
|
# Templates: allowed
|
|
extra_files:
|
|
- glob: ./path/to/file.txt
|
|
- glob: ./glob/**/to/**/file/**/*
|
|
- glob: ./glob/foo/to/bar/file/foobar/override_from_previous
|
|
- glob: ./single_file.txt
|
|
name_template: file.txt # note that this only works if glob matches 1 file only
|
|
|
|
|
|
# Additional templated extra files to add to the checksum.
|
|
# Those files will have their contents pass through the template engine,
|
|
# and its results will be added to the checksum.
|
|
#
|
|
# Since: v1.17 (pro)
|
|
# This feature is only available in GoReleaser Pro.
|
|
# Templates: allowed
|
|
templated_extra_files:
|
|
- src: LICENSE.tpl
|
|
dst: LICENSE.txt
|
|
|
|
```
|
|
|
|
!!! tip
|
|
Learn more about the [name template engine](/customization/templates/).
|