1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-24 04:16:27 +02:00
goreleaser/docs/020-environment.md

53 lines
1.4 KiB
Markdown
Raw Normal View History

2017-09-10 17:07:28 -03:00
---
title: Environment
2017-09-10 17:07:28 -03:00
---
## GitHub Token
2017-09-10 17:07:28 -03: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 17:07:28 -03: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 16: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 00:06:48 -02:00
## The dist folder
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
```
## Using the `main.version`
GoReleaser always sets a `main.version` _ldflag_.
You can use it in your `main.go` file:
```go
package main
var version = "master"
func main() {
println(version)
}
```
`version` will be set to the current Git tag (the `v` prefix is stripped) or the name of
the snapshot, if you're using the `--snapshot` flag.
You can override this by changing the `ldflags` option in the `build` section.