mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-03-29 21:47:01 +02:00
c04b18a289
This shortens the titles, fixes some typos, rephrases a few paragraphs, adds some additional information and attempts to keep vocabulary more consistent.
1.7 KiB
1.7 KiB
| title |
|---|
| Archive |
The binaries built will be archived together with the README and LICENSE files into a
tar.gz file. In the archive section you can customize the archive name,
additional files, and format.
Here is a commented archive section with all fields specified:
# .goreleaser.yml
archive:
# You can change the name of the archive.
# This is parsed with the Go template engine and the following variables
# are available:
# - ProjectName
# - Tag
# - Version (Git tag without `v` prefix)
# - Os
# - Arch
# - Arm (ARM version)
# Default is `{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}`.
name_template: "{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}"
# Archive format. Valid options are `tar.gz`, `zip` and `binary`.
# If format is `binary`, no archives are created and the binaries are instead uploaded directly.
# In that case name_template and the below specified files are ignored.
# Default is `tar.gz`.
format: zip
# Can be used to change the archive formats for specific GOOSs.
# Most common use case is to archive as zip on Windows.
# Default is empty.
format_overrides:
- goos: windows
format: zip
# Replacements for GOOS and GOARCH in the archive name.
# Keys should be valid GOOSs or GOARCHs.
# Values are the respective replacements.
# Default is empty.
replacements:
amd64: 64-bit
386: 32-bit
darwin: macOS
linux: Tux
# Additional files/globs you want to add to the archive.
# Defaults are any files matching `LICENCE*`, `LICENSE*`,
# `README*` and `CHANGELOG*` (case-insensitive).
files:
- LICENSE.txt
- README.md
- CHANGELOG.md
- docs/*
- design/*.png