From ac206f84422d283808352ce55e09e33377eb48f7 Mon Sep 17 00:00:00 2001
From: Andy Grunwald <andygrunwald@gmail.com>
Date: Sun, 6 May 2018 10:44:46 +0200
Subject: [PATCH] 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.
---
www/content/environment.md | 21 +++++++++++++++------
1 file changed, 15 insertions(+), 6 deletions(-)
diff --git a/www/content/environment.md b/www/content/environment.md
index f4c55a2d8..712bc4d0d 100644
--- a/www/content/environment.md
+++ b/www/content/environment.md
@@ -50,22 +50,31 @@ dist: another-folder-that-is-not-dist
## 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:
```go
package main
-var version = "master"
+import "fmt"
+
+var (
+ version = "dev"
+ commit = "none"
+ date = "unknown"
+)
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.
## Customizing Git