1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-04-13 11:50:34 +02:00

docs: improve install docs

Signed-off-by: Carlos A Becker <caarlos0@gmail.com>
This commit is contained in:
Carlos A Becker 2021-07-09 19:11:58 +00:00
parent e5a2e65fea
commit 939f2b002b
No known key found for this signature in database
GPG Key ID: E61E2F7DC14AB940

View File

@ -10,94 +10,81 @@ Here are the steps for each of them:
### homebrew tap
#### oss
=== "OSS"
```sh
brew install goreleaser/tap/goreleaser
```
```sh
brew install goreleaser/tap/goreleaser
```
#### pro
```sh
brew install goreleaser/tap/goreleaser-pro
```
=== "Pro"
```sh
brew install goreleaser/tap/goreleaser-pro
```
### homebrew
OSS-only, may not be the latest version.
```sh
brew install goreleaser
```
=== "OSS"
```sh
brew install goreleaser
```
### snapcraft
OSS only.
```sh
sudo snap install --classic goreleaser
```
=== "OSS"
```sh
sudo snap install --classic goreleaser
```
### scoop
#### oss
=== "OSS"
```sh
scoop bucket add goreleaser https://github.com/goreleaser/scoop-bucket.git
scoop install goreleaser
```
```sh
scoop bucket add goreleaser https://github.com/goreleaser/scoop-bucket.git
scoop install goreleaser
```
#### pro
```sh
scoop bucket add goreleaser https://github.com/goreleaser/scoop-bucket.git
scoop install goreleaser-pro
```
=== "Pro"
```sh
scoop bucket add goreleaser https://github.com/goreleaser/scoop-bucket.git
scoop install goreleaser-pro
```
### apt
#### setup repository
=== "OSS"
```sh
echo 'deb [trusted=yes] https://apt.fury.io/goreleaser/ /' | sudo tee /etc/apt/sources.list.d/goreleaser.list
sudo apt update
sudo apt install goreleaser
```
```sh
echo 'deb [trusted=yes] https://apt.fury.io/goreleaser/ /' | sudo tee /etc/apt/sources.list.d/goreleaser.list
sudo apt update
```
#### oss
```sh
sudo apt install goreleaser
```
#### pro
```sh
sudo apt install goreleaser-pro
```
=== "Pro"
```sh
echo 'deb [trusted=yes] https://apt.fury.io/goreleaser/ /' | sudo tee /etc/apt/sources.list.d/goreleaser.list
sudo apt update
sudo apt install goreleaser-pro
```
### yum
#### setup repository
=== "OSS"
```sh
echo '[goreleaser]
name=GoReleaser
baseurl=https://yum.fury.io/goreleaser/
enabled=1
gpgcheck=0' | sudo tee /etc/yum.repos.d/goreleaser.repo
sudo yum install goreleaser
```
```sh
echo '[goreleaser]
name=GoReleaser
baseurl=https://yum.fury.io/goreleaser/
enabled=1
gpgcheck=0' | sudo tee /etc/yum.repos.d/goreleaser.repo
```
#### oss
```sh
sudo yum install goreleaser
```
#### pro
```sh
sudo yum install goreleaser-pro
```
=== "Pro"
```sh
echo '[goreleaser]
name=GoReleaser
baseurl=https://yum.fury.io/goreleaser/
enabled=1
gpgcheck=0' | sudo tee /etc/yum.repos.d/goreleaser.repo
sudo yum install goreleaser-pro
```
### deb, rpm and apk packages
@ -105,73 +92,75 @@ Download the `.deb`, `.rpm` or `.apk` from the [OSS][releases] or [Pro][pro-rele
### shell script
OSS only.
=== "OSS"
```sh
curl -sfL https://install.goreleaser.com/github.com/goreleaser/goreleaser.sh | sh
```
```sh
curl -sfL https://install.goreleaser.com/github.com/goreleaser/goreleaser.sh | sh
```
<!-- TODO: write a new shell script and store it within the website -->
### go install
OSS only.
```sh
go install github.com/goreleaser/goreleaser
```
=== "OSS"
```sh
go install github.com/goreleaser/goreleaser
```
### manually
Download the pre-compiled binaries from the [OSS][releases] or [Pro][pro-releases] releases pages and copy to the desired location.
=== "OSS"
Download the pre-compiled binaries from the [OSS][releases] releases pages and copy to the desired location.
=== "Pro"
Download the pre-compiled binaries from the [Pro][pro-releases] releases pages 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 examples bellow.
### oss
=== "OSS"
Registries:
Registries:
- [`goreleaser/goreleaser`](https://hub.docker.com/r/goreleaser/goreleaser)
- [`ghcr.io/goreleaser/goreleaser`](https://github.com/orgs/goreleaser/packages/container/package/goreleaser)
- [`goreleaser/goreleaser`](https://hub.docker.com/r/goreleaser/goreleaser)
- [`ghcr.io/goreleaser/goreleaser`](https://github.com/orgs/goreleaser/packages/container/package/goreleaser)
Example usage:
Example usage:
```sh
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
```
```sh
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
```
=== "Pro"
Registries:
### pro
- [`goreleaser/goreleaser-pro`](https://hub.docker.com/r/goreleaser/goreleaser-pro)
- [`ghcr.io/goreleaser/goreleaser-pro`](https://github.com/orgs/goreleaser/packages/container/package/goreleaser-pro)
Registries:
Example usage:
- [`goreleaser/goreleaser-pro`](https://hub.docker.com/r/goreleaser/goreleaser-pro)
- [`ghcr.io/goreleaser/goreleaser-pro`](https://github.com/orgs/goreleaser/packages/container/package/goreleaser-pro)
```sh
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 \
-e GORELEASER_KEY \
goreleaser/goreleaser-pro release
```
Example usage:
```sh
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 \
-e GORELEASER_KEY \
goreleaser/goreleaser-pro release
```
!!! info
Currently, the provided docker image does not support