mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-01-10 03:47:03 +02:00
93259b0683
* feat(release): add artifact filter (by id) to release pipe * add `ids: string[]` to release configuration * add support for filtering artifacts by id within the release pipe * update docs for release
164 lines
4.5 KiB
Markdown
164 lines
4.5 KiB
Markdown
---
|
|
title: Release
|
|
series: customization
|
|
hideFromIndex: true
|
|
weight: 110
|
|
---
|
|
|
|
GoReleaser will create a GitHub/GitLab release with the current tag, upload all
|
|
the artifacts and generate the changelog based on the new commits since the
|
|
previous tag.
|
|
|
|
Let's see what can be customized in the `release` section for GitHub:
|
|
|
|
```yml
|
|
# .goreleaser.yml
|
|
release:
|
|
# Repo in which the release will be created.
|
|
# Default is extracted from the origin remote URL.
|
|
# Note: it can only be one: either github or gitlab or gitea
|
|
github:
|
|
owner: user
|
|
name: repo
|
|
|
|
# IDs of the archives to use.
|
|
# Defaults to all.
|
|
ids:
|
|
- foo
|
|
- bar
|
|
|
|
# If set to true, will not auto-publish the release.
|
|
# Default is false.
|
|
draft: true
|
|
|
|
# If set to auto, will mark the release as not ready for production
|
|
# in case there is an indicator for this in the tag e.g. v1.0.0-rc1
|
|
# If set to true, will mark the release as not ready for production.
|
|
# Default is false.
|
|
prerelease: auto
|
|
|
|
# You can change the name of the GitHub release.
|
|
# Default is `{{.Tag}}`
|
|
name_template: "{{.ProjectName}}-v{{.Version}} {{.Env.USER}}"
|
|
|
|
# You can disable this pipe in order to not upload any artifacts to
|
|
# GitHub.
|
|
# Defaults to false.
|
|
disable: true
|
|
```
|
|
|
|
Second, let's see what can be customized in the `release` section for GitLab.
|
|
**Note** that only GitLab `v11.7+` are supported for releases:
|
|
|
|
```yml
|
|
# .goreleaser.yml
|
|
release:
|
|
# Same as for github
|
|
# Note: it can only be one: either github or gitlab or gitea
|
|
gitlab:
|
|
owner: user
|
|
name: repo
|
|
|
|
# IDs of the archives to use.
|
|
# Defaults to all.
|
|
ids:
|
|
- foo
|
|
- bar
|
|
|
|
# You can change the name of the GitLab release.
|
|
# Default is `{{.Tag}}`
|
|
name_template: "{{.ProjectName}}-v{{.Version}} {{.Env.USER}}"
|
|
|
|
# You can disable this pipe in order to not upload any artifacts to
|
|
# GitLab.
|
|
# Defaults to false.
|
|
disable: true
|
|
```
|
|
|
|
You can also configure the `release` section to upload to a [Gitea](https://gitea.io) instance:
|
|
```yml
|
|
# .goreleaser.yml
|
|
release:
|
|
# Same as for github and gitlab
|
|
# Note: it can only be one: either github or gitlab or gitea
|
|
gitea:
|
|
owner: user
|
|
name: repo
|
|
|
|
# IDs of the archives to use.
|
|
# Defaults to all.
|
|
ids:
|
|
- foo
|
|
- bar
|
|
|
|
# You can change the name of the Gitea release.
|
|
# Default is `{{.Tag}}`
|
|
name_template: "{{.ProjectName}}-v{{.Version}} {{.Env.USER}}"
|
|
|
|
# You can disable this pipe in order to not upload any artifacts to
|
|
# Gitea.
|
|
# Defaults to false.
|
|
disable: true
|
|
```
|
|
|
|
To enable uploading `tar.gz` and `checksums.txt` files you need to add the following to your Gitea config in `app.ini`:
|
|
```ini
|
|
[attachment]
|
|
ALLOWED_TYPES = application/gzip|application/x-gzip|application/x-gtar|application/x-tgz|application/x-compressed-tar|text/plain
|
|
```
|
|
|
|
> Gitea versions earlier than 1.9.2 do not support uploading `checksums.txt` files because of a [bug](https://github.com/go-gitea/gitea/issues/7882)
|
|
so you will have to enable all file types with `*/*`.
|
|
|
|
**Note**: `draft` and `prerelease` are only supported by GitHub and Gitea.
|
|
|
|
> Learn more about the [name template engine](/templates).
|
|
|
|
## Customize the changelog
|
|
|
|
You can customize how the changelog is generated using the
|
|
`changelog` section in the config file:
|
|
|
|
```yaml
|
|
# .goreleaser.yml
|
|
changelog:
|
|
# set it to true if you wish to skip the changelog generation
|
|
skip: true
|
|
# could either be asc, desc or empty
|
|
# Default is empty
|
|
sort: asc
|
|
filters:
|
|
# commit messages matching the regexp listed here will be removed from
|
|
# the changelog
|
|
# Default is empty
|
|
exclude:
|
|
- '^docs:'
|
|
- typo
|
|
- (?i)foo
|
|
```
|
|
|
|
## 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](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 <(some_changelog_generator)
|
|
```
|
|
|
|
Some changelog generators you can use:
|
|
|
|
- [buchanae/github-release-notes](https://github.com/buchanae/github-release-notes)
|
|
|
|
> **Important**: If you create the release before running GoReleaser, and the
|
|
> said release has some text in its body, GoReleaser will not override it with
|
|
> it's release notes.
|