1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-03-19 20:57:53 +02:00

docs: Add main.commit and main.date to environment section

In the default golang builders ldflags three flags are set:
main.version, main.commit and main.date.
See https://github.com/goreleaser/goreleaser/blob/master/internal/builders/golang/build.go#L48

In the environment docs, only the main.version is mentioned.
goreleaser itself uses main.date and main.commit also.
This commit is contained in:
Andy Grunwald 2018-05-06 10:44:46 +02:00 committed by Carlos Alexandro Becker
parent 3199f72336
commit ac206f8442

View File

@ -50,22 +50,31 @@ dist: another-folder-that-is-not-dist
## Using the `main.version` ## Using the `main.version`
GoReleaser always sets a `main.version` _ldflag_. Default wise GoReleaser sets three _ldflags_:
- `main.version`: Current Git tag (the `v` prefix is stripped) or the name of
the snapshot, if you're using the `--snapshot` flag
- `main.commit`: Current git commit SHA
- `main.date`: Date according [RFC3339](https://golang.org/pkg/time/#pkg-constants)
You can use it in your `main.go` file: You can use it in your `main.go` file:
```go ```go
package main package main
var version = "master" import "fmt"
var (
version = "dev"
commit = "none"
date = "unknown"
)
func main() { func main() {
println(version) fmt.Printf("%v, commit %v, built at %v", version, commit, date)
} }
``` ```
`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. You can override this by changing the `ldflags` option in the `build` section.
## Customizing Git ## Customizing Git