1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-10 03:47:03 +02:00
goreleaser/www/content/introduction.md
2018-05-01 20:32:46 -07:00

57 lines
1.5 KiB
Markdown

---
title: Introduction
weight: 1
menu: true
---
[GoReleaser](https://github.com/goreleaser/goreleaser) is a release automation
tool for Go projects, the goal is to simplify the build, release and
publish steps while providing variant customization options for all steps.
GoReleaser is built for CI tools; you only need to
[download and execute it](#ci_integration) in your build script.
You can [customize](#customization) your release process by
creating a `.goreleaser.yml` file.
The idea started with a
[simple shell script](https://github.com/goreleaser/old-go-releaser),
but it quickly became more complex and I also wanted to publish binaries via
Homebrew taps, which would have made the script even more hacky, so I let go of
that and rewrote the whole thing in Go.
## Installing Goreleaser
There are three ways to get going install GoReleaser:
### Using homebrew
```sh
brew install goreleaser/tap/goreleaser
```
### Using Scoop
```sh
scoop bucket add goreleaser https://github.com/goreleaser/scoop-bucket.git
scoop install goreleaser
```
> Check the [tap source](https://github.com/goreleaser/homebrew-tap) for
> more details.
## Manually
Download your preferred flavor from the [releases page](https://github.com/goreleaser/goreleaser/releases/latest) and install
manually.
### Using go get
Note: this method requires Go 1.10+.
```console
$ go get github.com/goreleaser/goreleaser
```
It is recommended to also run `dep ensure` to make sure that the dependencies
are in the correct versions.