1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-10 03:47:03 +02:00
goreleaser/www/docs/customization/source.md

41 lines
1.0 KiB
Markdown
Raw Normal View History

2021-10-30 14:50:23 +02:00
# 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.
# Defaults to `false`
enabled: true
# Name template of the final archive.
# Defaults to `{{ .ProjectName }}-{{ .Version }}`
name_template: '{{ .ProjectName }}'
# Format of the archive.
# Any format git-archive supports, this supports too.
# Defaults to `tar.gz`
format: 'tar'
# Prefix template.
# String to prepend to each filename in the archive.
# Defaults to empty
prefix_template: '{{ .ProjectName }}-{{ .Version }}/'
# Additional files/template/globs you want to add to the source archive.
# Will use --add-file of git-archive.
# Defaults to empty.
files:
- LICENSE.txt
- README_{{.Os}}.md
- CHANGELOG.md
- docs/*
- design/*.png
- templates/**/*
```
!!! tip
Learn more about the [name template engine](/customization/templates/).