mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-01-08 03:31:59 +02:00
117 lines
2.5 KiB
Markdown
117 lines
2.5 KiB
Markdown
# Install
|
|
|
|
You can install the pre-compiled binary (in several different ways),
|
|
use Docker or compile from source.
|
|
|
|
Here are the steps for each of them:
|
|
|
|
## Install the pre-compiled binary
|
|
|
|
**homebrew tap** (only on macOS for now):
|
|
|
|
```console
|
|
$ brew install goreleaser/tap/goreleaser
|
|
```
|
|
|
|
**homebrew** (may not be the latest version):
|
|
|
|
```console
|
|
$ brew install goreleaser
|
|
```
|
|
|
|
**snapcraft**:
|
|
|
|
```console
|
|
$ sudo snap install --classic goreleaser
|
|
```
|
|
|
|
**scoop**:
|
|
|
|
```console
|
|
$ scoop bucket add goreleaser https://github.com/goreleaser/scoop-bucket.git
|
|
$ scoop install goreleaser
|
|
```
|
|
|
|
**deb/rpm**:
|
|
|
|
Download the `.deb` or `.rpm` from the [releases page][releases] and
|
|
install with `dpkg -i` and `rpm -i` respectively.
|
|
|
|
**Shell script**:
|
|
|
|
```console
|
|
$ curl -sfL https://install.goreleaser.com/github.com/goreleaser/goreleaser.sh | sh
|
|
```
|
|
|
|
**manually**:
|
|
|
|
Download the pre-compiled binaries from the [releases page][releases] and
|
|
copy to the desired location.
|
|
|
|
## Running with Docker
|
|
|
|
You can also use it within a Docker container. To do that, you'll need to
|
|
execute something more-or-less like the following:
|
|
|
|
```console
|
|
$ docker run --rm --privileged \
|
|
-v $PWD:/go/src/github.com/user/repo \
|
|
-v /var/run/docker.sock:/var/run/docker.sock \
|
|
-w /go/src/github.com/user/repo \
|
|
-e GITHUB_TOKEN \
|
|
-e DOCKER_USERNAME \
|
|
-e DOCKER_PASSWORD \
|
|
-e DOCKER_REGISTRY \
|
|
goreleaser/goreleaser release
|
|
```
|
|
|
|
!!! info
|
|
Currently, the provided docker image does not support
|
|
the generation of snapcraft packages.
|
|
|
|
Note that the image will almost always have the last stable Go version.
|
|
|
|
The `DOCKER_REGISTRY` environment variable can be left empty when you are
|
|
releasing to the public docker registry.
|
|
|
|
If you need more things, you are encouraged to keep your own image. You can
|
|
always use GoReleaser's [own Dockerfile][dockerfile] as an example though
|
|
and iterate from that.
|
|
|
|
[dockerfile]: https://github.com/goreleaser/goreleaser/blob/master/Dockerfile
|
|
[releases]: https://github.com/goreleaser/goreleaser/releases
|
|
|
|
## Compiling from source
|
|
|
|
Here you have two options:
|
|
|
|
If you want to contribute to the project, please follow the
|
|
steps on our [contributing guide](/contributing).
|
|
|
|
If you just want to build from source for whatever reason, follow these steps:
|
|
|
|
**Clone:**
|
|
|
|
```console
|
|
$ git clone https://github.com/goreleaser/goreleaser
|
|
$ cd goreleaser
|
|
```
|
|
|
|
**Get the dependencies:**
|
|
|
|
```console
|
|
$ go get ./...
|
|
```
|
|
|
|
**Build:**
|
|
|
|
```console
|
|
$ go build -o goreleaser .
|
|
```
|
|
|
|
**Verify it works:**
|
|
|
|
```console
|
|
$ ./goreleaser --version
|
|
```
|