mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-03-31 21:55:34 +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>
88 lines
2.2 KiB
Markdown
88 lines
2.2 KiB
Markdown
# Source Archive
|
|
|
|
You may add the current tag source archive to the release as well. This is
|
|
particularly useful if you want to sign it, for example.
|
|
|
|
```yaml
|
|
# .goreleaser.yaml
|
|
source:
|
|
# Whether this pipe is enabled or not.
|
|
enabled: true
|
|
|
|
# Name template of the final archive.
|
|
#
|
|
# Default: '{{ .ProjectName }}-{{ .Version }}'
|
|
# Templates: allowed
|
|
name_template: '{{ .ProjectName }}'
|
|
|
|
# Format of the archive.
|
|
# Any format git-archive supports, this supports too.
|
|
#
|
|
# Default: 'tar.gz'
|
|
format: 'tar'
|
|
|
|
# Prefix.
|
|
# String to prepend to each filename in the archive.
|
|
#
|
|
# Templates: allowed
|
|
prefix_template: '{{ .ProjectName }}-{{ .Version }}/'
|
|
|
|
# This will make the destination paths be relative to the longest common
|
|
# path prefix between all the files matched and the source glob.
|
|
# Enabling this essentially mimic the behavior of nfpm's contents section.
|
|
# It will be the default by June 2023.
|
|
#
|
|
# Since: v1.14
|
|
rlcp: true
|
|
|
|
# Additional files/globs you want to add to the source archive.
|
|
#
|
|
# Since: v1.11
|
|
# Templates: allowed
|
|
files:
|
|
- LICENSE.txt
|
|
- README_{{.Os}}.md
|
|
- CHANGELOG.md
|
|
- docs/*
|
|
- design/*.png
|
|
- templates/**/*
|
|
# a more complete example, check the globbing deep dive below
|
|
- src: '*.md'
|
|
dst: docs
|
|
|
|
# Strip parent folders when adding files to the archive.
|
|
strip_parent: true
|
|
|
|
# File info.
|
|
# Not all fields are supported by all formats available formats.
|
|
# Default: file info of the source file
|
|
info:
|
|
owner: root
|
|
group: root
|
|
mode: 0644
|
|
# format is `time.RFC3339Nano`
|
|
mtime: 2008-01-02T15:04:05Z
|
|
|
|
|
|
# Additional templated files to add to the source archive.
|
|
# Those files will have their contents pass through the template engine,
|
|
# and its results will be added to the source archive.
|
|
#
|
|
# Since: v1.17 (pro)
|
|
# This feature is only available in GoReleaser Pro.
|
|
# Templates: allowed
|
|
files:
|
|
# a more complete example, check the globbing deep dive below
|
|
- src: 'LICENSE.md.tpl'
|
|
dst: LICENSE.md
|
|
info:
|
|
owner: root
|
|
group: root
|
|
mode: 0644
|
|
mtime: 2008-01-02T15:04:05Z
|
|
|
|
```
|
|
|
|
!!! tip
|
|
Learn more about the [name template engine](/customization/templates/).
|