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

46 lines
1.4 KiB
Markdown
Raw Normal View History

2017-09-10 22:07:28 +02:00
---
title: Releasing
2017-09-10 22:07:28 +02:00
---
GoReleaser will create a release in GitHub with the current tag, upload all
the archives and checksums, also generate a changelog from the commits new since the last tag.
2017-09-10 22:07:28 +02:00
Let's see what can be customized in the `release` section:
```yml
# .goreleaser.yml
release:
# Repo in which the release will be created.
# Default is extracted from the origin remote URL.
github:
owner: user
name: repo
# If set to true, will not auto-publish the release.
# Default is false.
2017-09-10 22:07:28 +02:00
draft: true
# If set to true, will mark the release as not ready for production.
# Default is false.
prerelease: true
# Optional template to name the release
# Default is the version number
name_template: "{{.ProjectName}}-v{{.Version}}"
2017-09-10 22:07:28 +02:00
```
## Custom release notes
You can specify a file containing your custom release notes, and
pass it with the `--release-notes=FILE` flag.
2017-09-10 22:07:28 +02:00
GoReleaser will then skip its own release notes generation,
using the contents of your file instead.
You can use Markdown to format the contents of your file.
On Unix systems you can also generate the release notes in-line by using [process substitution](https://en.wikipedia.org/wiki/Process_substitution).
To list all commits since the last tag, but skip ones starting with `Merge` or `docs`, you could run this command:
```sh
goreleaser --release-notes <(git log --pretty=oneline --abbrev-commit $(git describe --tags --abbrev=0)^.. | grep -v '^[^ ]* \(Merge\|docs\)')
```