2017-09-10 22:07:28 +02:00
---
2017-11-27 01:55:59 +02:00
title: Environment
2018-04-25 07:20:12 +02:00
weight: 20
menu: true
2017-09-10 22:07:28 +02:00
---
2017-12-04 13:49:29 +02:00
## GitHub Token
2017-09-10 22:07:28 +02:00
2017-10-01 18:57:52 +02:00
GoReleaser requires a GitHub API token with the `repo` scope selected to
deploy the artifacts to GitHub.
You can create one [here ](https://github.com/settings/tokens/new ).
2017-09-10 22:07:28 +02:00
This token should be added to the environment variables as `GITHUB_TOKEN` .
Here is how to do it with Travis CI:
[Defining Variables in Repository Settings ](https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings ).
2018-02-03 20:47:26 +02:00
Alternatively, you can provide the GitHub token in a file. GoReleaser will check `~/.config/goreleaser/github_token` by default, you can change that in
the `.goreleaser.yml` file:
```yaml
# .goreleaser.yml
env_files:
github_token: ~/.path/to/my/token
```
2018-02-03 04:06:48 +02:00
2018-02-19 01:37:59 +02:00
## GitHub Enterprise
You can use GoReleaser with GitHub Enterprise by providing its URLs in
the `.goreleaser.yml` configuration file:
```yaml
# .goreleaser.yml
github_urls:
2018-05-09 01:43:40 +02:00
api: https://git.company.com/api/v3/
upload: https://git.company.com/api/uploads/
download: https://git.company.com/
2019-01-19 22:16:25 +02:00
# set to true if you use a self-signed certificate
skip_tls_verify: false
2018-02-19 01:37:59 +02:00
```
If none are set, they default to GitHub's public URLs.
2018-09-03 14:23:37 +02:00
**IMPORTANT**: be careful with the URLs, they may change from one installation
2018-05-09 01:43:40 +02:00
to another. If they are wrong, goreleaser will fail at some point, so, make
sure they're right before opening an issue. See for example [#472][472].
[472]: https://github.com/goreleaser/goreleaser/issues/472
2017-12-04 13:49:29 +02:00
## The dist folder
2017-11-27 01:50:49 +02:00
By default, GoReleaser will create its artifacts in the `./dist` folder.
If you must, you can change it by setting it in the `.goreleaser.yml` file:
```yaml
# .goreleaser.yml
dist: another-folder-that-is-not-dist
```
2017-11-27 01:58:58 +02:00
2017-12-04 13:49:29 +02:00
## Using the `main.version`
2017-11-27 01:58:58 +02:00
2018-05-06 14:19:14 +02:00
Default wise GoReleaser sets three _ldflags_ :
2018-05-06 10:44:46 +02:00
2018-05-28 15:49:38 +02:00
- `main.version` : Current Git tag (the `v` prefix is stripped) or the name of
2018-05-06 14:19:14 +02:00
the snapshot, if you're using the `--snapshot` flag
2018-05-28 15:49:38 +02:00
- `main.commit` : Current git commit SHA
- `main.date` : Date according [RFC3339 ](https://golang.org/pkg/time/#pkg-constants )
2018-05-06 10:44:46 +02:00
2017-11-27 01:58:58 +02:00
You can use it in your `main.go` file:
```go
package main
2018-05-06 10:44:46 +02:00
import "fmt"
var (
version = "dev"
commit = "none"
date = "unknown"
)
2017-11-27 01:58:58 +02:00
func main() {
2018-05-06 10:44:46 +02:00
fmt.Printf("%v, commit %v, built at %v", version, commit, date)
2017-11-27 01:58:58 +02:00
}
```
You can override this by changing the `ldflags` option in the `build` section.