mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-01-10 03:47:03 +02:00
ee67918187
I updated the default release name to match the git tag, per the request in the PR. Signed-off-by: Matt Stratton <matt.stratton@gmail.com>
1.6 KiB
1.6 KiB
title |
---|
Releasing |
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.
Let's see what can be customized in the release
section:
# .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.
draft: true
# If set to true, will mark the release as not ready for production.
# Default is false.
prerelease: true
# You can change the name of the GitHub release.
# This is parsed with the Go template engine and the following variables
# are available:
# - ProjectName
# - Tag
# - Version (Git tag without `v` prefix)
# Default is ``
name_template: "{{.ProjectName}}-v{{.Version}}"
Custom release notes
You can specify a file containing your custom release notes, and
pass it with the --release-notes=FILE
flag.
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.
To list all commits since the last tag, but skip ones starting with Merge
or docs
, you could run this command:
goreleaser --release-notes <(git log --pretty=oneline --abbrev-commit $(git describe --tags --abbrev=0)^.. | grep -v '^[^ ]* \(Merge\|docs\)')