1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-03-29 21:47:01 +02:00
goreleaser/docs/115-release.md
Carlos Alexandro Becker bd8494636f
docs improvements
2017-09-24 14:26:12 -03:00

1018 B

title
Custom releasing

GoRelease will create a release in GitHub with the current tag, upload all the archives and checksums, also generating a changelog from the commit log between the current and previous tags.

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
    # endpoint urls for github enterprise.
    # Defaults are the github.com URLs.
    api_url: github api endpoint
    uploads_url: github file uploads url
    downloads_url: github download url

  # If set to true, will not auto-publish the release.
  # Default is false
  draft: true

Custom release notes

You can have a markdown file previously created with the release notes, and pass it down to goreleaser with the --release-notes=FILE flag. GoReleaser will then skip its own release notes generation, using the contents of your file instead.