mirror of
https://github.com/therootcompany/go-gitver.git
synced 2024-11-16 17:08:59 +00:00
Compare commits
No commits in common. "master" and "v1.1.0" have entirely different histories.
4
.gitignore
vendored
4
.gitignore
vendored
@ -1,10 +1,6 @@
|
||||
xversion.go
|
||||
zversion.go
|
||||
|
||||
/go-gitver
|
||||
hello
|
||||
examples/*/*.sum
|
||||
|
||||
# ---> Go
|
||||
# Binaries for programs and plugins
|
||||
*.exe
|
||||
|
||||
@ -1 +0,0 @@
|
||||
{}
|
||||
139
README.md
139
README.md
@ -1,84 +1,24 @@
|
||||
# [Go GitVer](https://git.rootprojects.org/root/go-gitver)
|
||||
# git-version.go
|
||||
|
||||
Use **git tags** to add (GoReleaser-compatible) [**semver**](https://semver.org/)
|
||||
to your go package in under 150
|
||||
[lines of code](https://git.rootprojects.org/root/go-gitver/src/branch/master/gitver/gitver.go).
|
||||
Use git tags to add semver to your go package.
|
||||
|
||||
```txt
|
||||
Goals:
|
||||
|
||||
1. Use an exact `git tag` version, like v1.0.0, when clean
|
||||
2. Translate the `git describe` version (v1.0.0-4-g0000000)
|
||||
to semver (1.0.1-pre4+g0000000) in between releases
|
||||
3. Note when `dirty` (and have build timestamp)
|
||||
Goal: Either use an exact version like v1.0.0
|
||||
or translate the git version like v1.0.0-4-g0000000
|
||||
to a semver like v1.0.1-pre4+g0000000
|
||||
|
||||
Fail gracefully when git repo isn't available.
|
||||
```
|
||||
|
||||
# GoDoc
|
||||
|
||||
See <https://pkg.go.dev/git.rootprojects.org/root/go-gitver/v2>.
|
||||
|
||||
# How it works
|
||||
|
||||
1. You define the fallback version and version printing in `main.go`:
|
||||
|
||||
```go
|
||||
//go:generate go run git.rootprojects.org/root/go-gitver/v2
|
||||
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
)
|
||||
|
||||
var (
|
||||
commit = "0000000"
|
||||
version = "0.0.0-pre0+0000000"
|
||||
date = "0000-00-00T00:00:00+0000"
|
||||
)
|
||||
|
||||
func main() {
|
||||
if (len(os.Args) > 1 && "version" == strings.TrimLeft(os.Args[1], "-")) {
|
||||
fmt.Printf("Foobar v%s (%s) %s\n", version, commit[:7], date)
|
||||
}
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
2. You `go generate` or `go run git.rootprojects.org/root/go-gitver/v2` to generate `xversion.go`:
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
func init() {
|
||||
commit = "0921ed1e"
|
||||
version = "1.1.2"
|
||||
date = "2019-07-01T02:32:58-06:00"
|
||||
}
|
||||
```
|
||||
|
||||
# Demo
|
||||
|
||||
Generate an `xversion.go` file:
|
||||
|
||||
```bash
|
||||
go run git.rootprojects.org/root/go-gitver/v2
|
||||
go run git.rootprojects.org/root/go-gitver
|
||||
cat xversion.go
|
||||
```
|
||||
|
||||
```go
|
||||
// Code generated by go generate; DO NOT EDIT.
|
||||
package main
|
||||
|
||||
func init() {
|
||||
commit = "6dace8255b52e123297a44629bc32c015add310a"
|
||||
version = "1.1.4-pre2+g6dace82"
|
||||
date = "2020-07-16T20:48:15-06:00"
|
||||
}
|
||||
```
|
||||
|
||||
<small>**Note**: The file is named `xversion.go` by default so that the
|
||||
generated file's `init()` will come later, and thus take priority, over
|
||||
most other files.</small>
|
||||
@ -86,21 +26,15 @@ most other files.</small>
|
||||
See `go-gitver`s self-generated version:
|
||||
|
||||
```bash
|
||||
go run git.rootprojects.org/root/go-gitver/v2 version
|
||||
```
|
||||
|
||||
```txt
|
||||
6dace8255b52e123297a44629bc32c015add310a
|
||||
v1.1.4-pre2+g6dace82
|
||||
2020-07-16T20:48:15-06:00
|
||||
go run git.rootprojects.org/root/go-gitver version
|
||||
```
|
||||
|
||||
# QuickStart
|
||||
|
||||
Add this to the top of your main file, so that it runs with `go generate`:
|
||||
Add this to the top of your main file:
|
||||
|
||||
```go
|
||||
//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver/v2
|
||||
//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver
|
||||
|
||||
```
|
||||
|
||||
@ -111,7 +45,7 @@ Add a file that imports go-gitver (for versioning)
|
||||
|
||||
package example
|
||||
|
||||
import _ "git.rootprojects.org/root/go-gitver/v2"
|
||||
import _ "git.rootprojects.org/root/go-gitver"
|
||||
```
|
||||
|
||||
Change you build instructions to be something like this:
|
||||
@ -122,11 +56,11 @@ go generate -mod=vendor ./...
|
||||
go build -mod=vendor -o example cmd/example/*.go
|
||||
```
|
||||
|
||||
You don't have to use `-mod=vendor`, but I highly recommend it (just `go mod tidy; go mod vendor` to start).
|
||||
You don't have to use `mod vendor`, but I highly recommend it.
|
||||
|
||||
# Options
|
||||
|
||||
```txt
|
||||
```
|
||||
version print version and exit
|
||||
--fail exit with non-zero status code on failure
|
||||
--package <name> will set the package name
|
||||
@ -135,7 +69,7 @@ version print version and exit
|
||||
|
||||
ENVs
|
||||
|
||||
```bash
|
||||
```
|
||||
# Alias for --fail
|
||||
GITVER_FAIL=true
|
||||
```
|
||||
@ -143,12 +77,12 @@ GITVER_FAIL=true
|
||||
For example:
|
||||
|
||||
```go
|
||||
//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver/v2 --fail
|
||||
//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver --fail
|
||||
|
||||
```
|
||||
|
||||
```bash
|
||||
go run -mod=vendor git.rootprojects.org/root/go-gitver/v2 version
|
||||
go run -mod=vendor git.rootprojects.org/root/go-gitver version
|
||||
```
|
||||
|
||||
# Usage
|
||||
@ -157,9 +91,9 @@ See `examples/basic`
|
||||
|
||||
1. Create a `tools` package in your project
|
||||
2. Guard it against regular builds with `// +build tools`
|
||||
3. Include `_ "git.rootprojects.org/root/go-gitver/v2"` in the imports
|
||||
4. Declare `var commit, version, date string` in your `package main`
|
||||
5. Include `//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver/v2` as well
|
||||
3. Include `_ "git.rootprojects.org/root/go-gitver"` in the imports
|
||||
4. Declare `var GitRev, GitVersion, GitTimestamp string` in your `package main`
|
||||
5. Include `//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver` as well
|
||||
|
||||
`tools/tools.go`:
|
||||
|
||||
@ -170,29 +104,29 @@ See `examples/basic`
|
||||
package tools
|
||||
|
||||
import (
|
||||
_ "git.rootprojects.org/root/go-gitver/v2"
|
||||
_ "git.rootprojects.org/root/go-gitver"
|
||||
)
|
||||
```
|
||||
|
||||
`main.go`:
|
||||
|
||||
```go
|
||||
//go:generate go run git.rootprojects.org/root/go-gitver/v2 --fail
|
||||
//go:generate go run git.rootprojects.org/root/go-gitver --fail
|
||||
|
||||
package main
|
||||
|
||||
import "fmt"
|
||||
|
||||
var (
|
||||
commit = "0000000"
|
||||
version = "0.0.0-pre0+0000000"
|
||||
date = "0000-00-00T00:00:00+0000"
|
||||
GitRev = "0000000"
|
||||
GitVersion = "v0.0.0-pre0+0000000"
|
||||
GitTimestamp = "0000-00-00T00:00:00+0000"
|
||||
)
|
||||
|
||||
func main() {
|
||||
fmt.Println(commit)
|
||||
fmt.Println(version)
|
||||
fmt.Println(date)
|
||||
fmt.Println(GitRev)
|
||||
fmt.Println(GitVersion)
|
||||
fmt.Println(GitTimestamp)
|
||||
}
|
||||
```
|
||||
|
||||
@ -200,7 +134,7 @@ If you're using `go mod vendor` (which I highly recommend that you do),
|
||||
you'd modify the `go:generate` ever so slightly:
|
||||
|
||||
```go
|
||||
//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver/v2 --fail
|
||||
//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver --fail
|
||||
```
|
||||
|
||||
The only reason I didn't do that in the example is that I'd be included
|
||||
@ -208,7 +142,7 @@ the repository in itself and that would be... weird.
|
||||
|
||||
# Why a tools package?
|
||||
|
||||
> import "git.rootprojects.org/root/go-gitver/v2" is a program, not an importable package
|
||||
> import "git.rootprojects.org/root/go-gitver" is a program, not an importable package
|
||||
|
||||
Having a tools package with a build tag that you don't use is a nice way to add exact
|
||||
versions of a command package used for tooling to your `go.mod` with `go mod tidy`,
|
||||
@ -242,20 +176,3 @@ Shows the most recent commit.
|
||||
git rev-parse HEAD
|
||||
# 0000000000000000000000000000000000000000
|
||||
```
|
||||
|
||||
# Errors
|
||||
|
||||
### cannot find package "."
|
||||
|
||||
```txt
|
||||
package git.rootprojects.org/root/go-gitver/v2: cannot find package "." in:
|
||||
/Users/me/go-example/vendor/git.rootprojects.org/root/go-gitver/v2
|
||||
cmd/example/example.go:1: running "go": exit status 1
|
||||
```
|
||||
|
||||
You forgot to update deps and re-vendor:
|
||||
|
||||
```bash
|
||||
go mod tidy
|
||||
go mod vendor
|
||||
```
|
||||
|
||||
@ -2,4 +2,4 @@ module example.com/hello
|
||||
|
||||
go 1.12
|
||||
|
||||
require git.rootprojects.org/root/go-gitver/v2 v2.0.2
|
||||
require git.rootprojects.org/root/go-gitver v1.1.0
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver/v2 --fail
|
||||
//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver --fail
|
||||
|
||||
package main
|
||||
|
||||
@ -8,9 +8,9 @@ import (
|
||||
)
|
||||
|
||||
var (
|
||||
commit = "0000000"
|
||||
version = "0.0.0-pre0+0000000"
|
||||
date = "0000-00-00T00:00:00+0000"
|
||||
GitRev = "0000000"
|
||||
GitVersion = "v0.0.0-pre0+0000000"
|
||||
GitTimestamp = "0000-00-00T00:00:00+0000"
|
||||
)
|
||||
|
||||
func main() {
|
||||
@ -18,9 +18,9 @@ func main() {
|
||||
flag.Parse()
|
||||
|
||||
if *showVersion {
|
||||
fmt.Println(commit)
|
||||
fmt.Println(version)
|
||||
fmt.Println(date)
|
||||
fmt.Println(GitRev)
|
||||
fmt.Println(GitVersion)
|
||||
fmt.Println(GitTimestamp)
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
@ -4,5 +4,5 @@
|
||||
package tools
|
||||
|
||||
import (
|
||||
_ "git.rootprojects.org/root/go-gitver/v2"
|
||||
_ "git.rootprojects.org/root/go-gitver"
|
||||
)
|
||||
|
||||
@ -2,4 +2,4 @@ module example.com/hello
|
||||
|
||||
go 1.12
|
||||
|
||||
require git.rootprojects.org/root/go-gitver/v2 v2.0.2
|
||||
require git.rootprojects.org/root/go-gitver v1.1.0
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver/v2 --fail
|
||||
//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver --fail
|
||||
|
||||
package main
|
||||
|
||||
@ -8,9 +8,9 @@ import (
|
||||
)
|
||||
|
||||
var (
|
||||
commit = "0000000"
|
||||
version = "0.0.0-pre0+0000000"
|
||||
date = "0000-00-00T00:00:00+0000"
|
||||
GitRev = "0000000"
|
||||
GitVersion = "v0.0.0-pre0+0000000"
|
||||
GitTimestamp = "0000-00-00T00:00:00+0000"
|
||||
)
|
||||
|
||||
func main() {
|
||||
@ -18,9 +18,9 @@ func main() {
|
||||
flag.Parse()
|
||||
|
||||
if *showVersion {
|
||||
fmt.Println(commit)
|
||||
fmt.Println(version)
|
||||
fmt.Println(date)
|
||||
fmt.Println(GitRev)
|
||||
fmt.Println(GitVersion)
|
||||
fmt.Println(GitTimestamp)
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
@ -3,4 +3,4 @@
|
||||
// This is a dummy file for build tooling
|
||||
package main
|
||||
|
||||
import _ "git.rootprojects.org/root/go-gitver/v2"
|
||||
import _ "git.rootprojects.org/root/go-gitver"
|
||||
|
||||
@ -2,4 +2,4 @@ module example.com/hello
|
||||
|
||||
go 1.12
|
||||
|
||||
require git.rootprojects.org/root/go-gitver/v2 v2.0.2
|
||||
require git.rootprojects.org/root/go-gitver v1.1.0
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver/v2 --package version --outfile ./version/zversion.go
|
||||
//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver --package version --outfile ./version/zversion.go
|
||||
|
||||
package main
|
||||
|
||||
@ -14,9 +14,9 @@ func main() {
|
||||
flag.Parse()
|
||||
|
||||
if *showVersion {
|
||||
fmt.Println(version.Commit())
|
||||
fmt.Println(version.Version())
|
||||
fmt.Println(version.Date())
|
||||
fmt.Println(version.GitRev)
|
||||
fmt.Println(version.GitVersion)
|
||||
fmt.Println(version.GitTimestamp)
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
@ -4,5 +4,5 @@
|
||||
package tools
|
||||
|
||||
import (
|
||||
_ "git.rootprojects.org/root/go-gitver/v2"
|
||||
_ "git.rootprojects.org/root/go-gitver"
|
||||
)
|
||||
|
||||
@ -1,22 +1,7 @@
|
||||
package version
|
||||
|
||||
var (
|
||||
commit = "0000000"
|
||||
version = "0.0.0-pre0+0000000"
|
||||
date = "0000-00-00T00:00:00+0000"
|
||||
GitRev = "0000000"
|
||||
GitVersion = "v0.0.0-pre0+0000000"
|
||||
GitTimestamp = "0000-00-00T00:00:00+0000"
|
||||
)
|
||||
|
||||
// Commit returns the git commit reference
|
||||
func Commit() string {
|
||||
return commit
|
||||
}
|
||||
|
||||
// Version returns the git version, without the leading 'v'
|
||||
func Version() string {
|
||||
return version
|
||||
}
|
||||
|
||||
// Date returns the ISO-formatted date string
|
||||
func Date() string {
|
||||
return date
|
||||
}
|
||||
|
||||
@ -2,4 +2,4 @@ module example.com/hello
|
||||
|
||||
go 1.12
|
||||
|
||||
require git.rootprojects.org/root/go-gitver/v2 v2.0.2
|
||||
require git.rootprojects.org/root/go-gitver v1.1.0
|
||||
|
||||
@ -12,9 +12,9 @@ func main() {
|
||||
flag.Parse()
|
||||
|
||||
if *showVersion {
|
||||
fmt.Println(version.Commit())
|
||||
fmt.Println(version.Version())
|
||||
fmt.Println(version.Date())
|
||||
fmt.Println(version.GitRev)
|
||||
fmt.Println(version.GitVersion)
|
||||
fmt.Println(version.GitTimestamp)
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
@ -4,5 +4,5 @@
|
||||
package tools
|
||||
|
||||
import (
|
||||
_ "git.rootprojects.org/root/go-gitver/v2"
|
||||
_ "git.rootprojects.org/root/go-gitver"
|
||||
)
|
||||
|
||||
@ -1,24 +1,9 @@
|
||||
//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver/v2 --package version
|
||||
//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver --package version
|
||||
|
||||
package version
|
||||
|
||||
var (
|
||||
commit = "0000000"
|
||||
version = "0.0.0-pre0+0000000"
|
||||
date = "0000-00-00T00:00:00+0000"
|
||||
GitRev = "0000000"
|
||||
GitVersion = "v0.0.0-pre0+0000000"
|
||||
GitTimestamp = "0000-00-00T00:00:00+0000"
|
||||
)
|
||||
|
||||
// Commit returns the git commit reference
|
||||
func Commit() string {
|
||||
return commit
|
||||
}
|
||||
|
||||
// Version returns the git version, without the leading 'v'
|
||||
func Version() string {
|
||||
return version
|
||||
}
|
||||
|
||||
// Date returns the ISO-formatted date string
|
||||
func Date() string {
|
||||
return date
|
||||
}
|
||||
|
||||
179
gitver.go
179
gitver.go
@ -1,4 +1,4 @@
|
||||
//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver/v2
|
||||
//go:generate go run -mod=vendor git.rootprojects.org/root/go-gitver
|
||||
|
||||
package main
|
||||
|
||||
@ -6,17 +6,36 @@ import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"go/format"
|
||||
"log"
|
||||
"os"
|
||||
"os/exec"
|
||||
"regexp"
|
||||
"strconv"
|
||||
"strings"
|
||||
"text/template"
|
||||
"time"
|
||||
|
||||
"git.rootprojects.org/root/go-gitver/v2/gitver"
|
||||
)
|
||||
|
||||
var commit, version, date string
|
||||
var exitCode int
|
||||
var exactVer *regexp.Regexp
|
||||
var gitVer *regexp.Regexp
|
||||
var verFile = "xversion.go"
|
||||
|
||||
var (
|
||||
GitRev = "0000000"
|
||||
GitVersion = "v0.0.0-pre0+g0000000"
|
||||
GitTimestamp = "0000-00-00T00:00:00+0000"
|
||||
)
|
||||
|
||||
func init() {
|
||||
// exactly vX.Y.Z (go-compatible semver)
|
||||
exactVer = regexp.MustCompile(`^v\d+\.\d+\.\d+$`)
|
||||
|
||||
// vX.Y.Z-n-g0000000 git post-release, semver prerelease
|
||||
// vX.Y.Z-dirty git post-release, semver prerelease
|
||||
gitVer = regexp.MustCompile(`^(v\d+\.\d+)\.(\d+)(-(\d+))?(-(g[0-9a-f]+))?(-(dirty))?`)
|
||||
}
|
||||
|
||||
func main() {
|
||||
pkg := "main"
|
||||
|
||||
@ -32,9 +51,9 @@ func main() {
|
||||
pkg = args[i+1]
|
||||
args[i+1] = ""
|
||||
} else if "-V" == arg || "version" == arg || "-version" == arg || "--version" == arg {
|
||||
fmt.Println(commit)
|
||||
fmt.Println(version)
|
||||
fmt.Println(date)
|
||||
fmt.Println(GitRev)
|
||||
fmt.Println(GitVersion)
|
||||
fmt.Println(GitTimestamp)
|
||||
os.Exit(0)
|
||||
}
|
||||
}
|
||||
@ -42,30 +61,33 @@ func main() {
|
||||
exitCode = 1
|
||||
}
|
||||
|
||||
v, err := gitver.ExecAndParse()
|
||||
desc, err := gitDesc()
|
||||
if nil != err {
|
||||
fmt.Fprintf(os.Stderr, "Failed to get git version: %s\n", err)
|
||||
if exitCode > 0 {
|
||||
os.Exit(exitCode)
|
||||
}
|
||||
v = &gitver.Versions{
|
||||
Timestamp: time.Now(),
|
||||
}
|
||||
log.Fatalf("Failed to get git version: %s\n", err)
|
||||
os.Exit(exitCode)
|
||||
}
|
||||
rev := gitRev()
|
||||
ver := semVer(desc)
|
||||
ts, err := gitTimestamp(desc)
|
||||
if nil != err {
|
||||
ts = time.Now()
|
||||
}
|
||||
|
||||
v := struct {
|
||||
Package string
|
||||
Timestamp string
|
||||
Version string
|
||||
GitRev string
|
||||
}{
|
||||
Package: pkg,
|
||||
Timestamp: ts.Format(time.RFC3339),
|
||||
Version: ver,
|
||||
GitRev: rev,
|
||||
}
|
||||
|
||||
// Create or overwrite the go file from template
|
||||
var buf bytes.Buffer
|
||||
if err := versionTpl.Execute(&buf, struct {
|
||||
Package string
|
||||
Timestamp string
|
||||
Version string
|
||||
Commit string
|
||||
}{
|
||||
Package: pkg,
|
||||
Timestamp: v.Timestamp.Format(time.RFC3339),
|
||||
Version: v.Version,
|
||||
Commit: v.Rev,
|
||||
}); nil != err {
|
||||
if err := versionTpl.Execute(&buf, v); nil != err {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
@ -86,19 +108,110 @@ func main() {
|
||||
if err := f.Close(); nil != err {
|
||||
panic(err)
|
||||
}
|
||||
}
|
||||
|
||||
func gitDesc() (string, error) {
|
||||
args := strings.Split("git describe --tags --dirty --always", " ")
|
||||
cmd := exec.Command(args[0], args[1:]...)
|
||||
out, err := cmd.CombinedOutput()
|
||||
if nil != err {
|
||||
// Don't panic, just carry on
|
||||
//out = []byte("v0.0.0-0-g0000000")
|
||||
return "", err
|
||||
}
|
||||
return strings.TrimSpace(string(out)), nil
|
||||
}
|
||||
|
||||
func gitRev() string {
|
||||
args := strings.Split("git rev-parse HEAD", " ")
|
||||
cmd := exec.Command(args[0], args[1:]...)
|
||||
out, err := cmd.CombinedOutput()
|
||||
if nil != err {
|
||||
fmt.Fprintf(os.Stderr,
|
||||
"\nUnexpected Error\n\n"+
|
||||
"Please open an issue at https://git.rootprojects.org/root/go-gitver/issues/new \n"+
|
||||
"Please include the following:\n\n"+
|
||||
"Command: %s\n"+
|
||||
"Output: %s\n"+
|
||||
"Error: %s\n"+
|
||||
"\nPlease and Thank You.\n\n", strings.Join(args, " "), out, err)
|
||||
os.Exit(exitCode)
|
||||
}
|
||||
return strings.TrimSpace(string(out))
|
||||
}
|
||||
|
||||
func semVer(desc string) string {
|
||||
if exactVer.MatchString(desc) {
|
||||
// v1.0.0
|
||||
return desc
|
||||
}
|
||||
|
||||
if !gitVer.MatchString(desc) {
|
||||
return ""
|
||||
}
|
||||
|
||||
// (v1.0).(0)(-(1))(-(g0000000))(-(dirty))
|
||||
vers := gitVer.FindStringSubmatch(desc)
|
||||
patch, err := strconv.Atoi(vers[2])
|
||||
if nil != err {
|
||||
fmt.Fprintf(os.Stderr,
|
||||
"\nUnexpected Error\n\n"+
|
||||
"Please open an issue at https://git.rootprojects.org/root/go-gitver/issues/new \n"+
|
||||
"Please include the following:\n\n"+
|
||||
"git description: %s\n"+
|
||||
"RegExp: %#v\n"+
|
||||
"Error: %s\n"+
|
||||
"\nPlease and Thank You.\n\n", desc, gitVer, err)
|
||||
os.Exit(exitCode)
|
||||
}
|
||||
|
||||
// v1.0.1-pre1
|
||||
// v1.0.1-pre1+g0000000
|
||||
// v1.0.1-pre0+dirty
|
||||
// v1.0.1-pre0+g0000000-dirty
|
||||
if "" == vers[4] {
|
||||
vers[4] = "0"
|
||||
}
|
||||
ver := fmt.Sprintf("%s.%d-pre%s", vers[1], patch+1, vers[4])
|
||||
if "" != vers[6] || "dirty" == vers[8] {
|
||||
ver += "+"
|
||||
if "" != vers[6] {
|
||||
ver += vers[6]
|
||||
if "" != vers[8] {
|
||||
ver += "-"
|
||||
}
|
||||
}
|
||||
ver += vers[8]
|
||||
}
|
||||
|
||||
return ver
|
||||
}
|
||||
|
||||
func gitTimestamp(desc string) (time.Time, error) {
|
||||
args := []string{
|
||||
"git",
|
||||
"show", desc,
|
||||
"--format=%cd",
|
||||
"--date=format:%Y-%m-%dT%H:%M:%SZ%z",
|
||||
"--no-patch",
|
||||
}
|
||||
cmd := exec.Command(args[0], args[1:]...)
|
||||
out, err := cmd.CombinedOutput()
|
||||
if nil != err {
|
||||
// a dirty desc was probably used
|
||||
return time.Time{}, err
|
||||
}
|
||||
return time.Parse(time.RFC3339, strings.TrimSpace(string(out)))
|
||||
}
|
||||
|
||||
var versionTpl = template.Must(template.New("").Parse(`// Code generated by go generate; DO NOT EDIT.
|
||||
package {{ .Package }}
|
||||
|
||||
func init() {
|
||||
{{ if .Commit -}}
|
||||
commit = "{{ .Commit }}"
|
||||
{{ end -}}
|
||||
{{ if .Version -}}
|
||||
version = "{{ .Version }}"
|
||||
{{ end -}}
|
||||
date = "{{ .Timestamp }}"
|
||||
GitRev = "{{ .GitRev }}"
|
||||
if "" != "{{ .Version }}" {
|
||||
GitVersion = "{{ .Version }}"
|
||||
}
|
||||
GitTimestamp = "{{ .Timestamp }}"
|
||||
}
|
||||
`))
|
||||
|
||||
154
gitver/gitver.go
154
gitver/gitver.go
@ -1,154 +0,0 @@
|
||||
package gitver
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os/exec"
|
||||
"regexp"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
var exactVer *regexp.Regexp
|
||||
var gitVer *regexp.Regexp
|
||||
|
||||
func init() {
|
||||
// exactly vX.Y.Z (go-compatible semver)
|
||||
exactVer = regexp.MustCompile(`^v\d+\.\d+\.\d+$`)
|
||||
|
||||
// vX.Y.Z-n-g0000000 git post-release, semver prerelease
|
||||
// vX.Y.Z-dirty git post-release, semver prerelease
|
||||
gitVer = regexp.MustCompile(`^(v\d+\.\d+)\.(\d+)(-(\d+))?(-(g[0-9a-f]+))?(-(dirty))?`)
|
||||
}
|
||||
|
||||
// Versions describes the various version properties
|
||||
type Versions struct {
|
||||
Timestamp time.Time
|
||||
Version string
|
||||
Rev string
|
||||
}
|
||||
|
||||
// ExecAndParse will run git and parse the output
|
||||
func ExecAndParse() (*Versions, error) {
|
||||
desc, err := gitDesc()
|
||||
if nil != err {
|
||||
return nil, err
|
||||
}
|
||||
rev, err := gitRev()
|
||||
if nil != err {
|
||||
return nil, err
|
||||
}
|
||||
ver, err := semVer(desc)
|
||||
if nil != err {
|
||||
return nil, err
|
||||
}
|
||||
ts, err := gitTimestamp(desc)
|
||||
if nil != err {
|
||||
ts = time.Now()
|
||||
}
|
||||
|
||||
return &Versions{
|
||||
Timestamp: ts,
|
||||
Version: ver,
|
||||
Rev: rev,
|
||||
}, nil
|
||||
}
|
||||
|
||||
func gitDesc() (string, error) {
|
||||
args := strings.Split("git describe --tags --dirty --always", " ")
|
||||
cmd := exec.Command(args[0], args[1:]...)
|
||||
out, err := cmd.CombinedOutput()
|
||||
if nil != err {
|
||||
// Don't panic, just carry on
|
||||
//out = []byte("0.0.0-0-g0000000")
|
||||
return "", err
|
||||
}
|
||||
return strings.TrimSpace(string(out)), nil
|
||||
}
|
||||
|
||||
func gitRev() (string, error) {
|
||||
args := strings.Split("git rev-parse HEAD", " ")
|
||||
cmd := exec.Command(args[0], args[1:]...)
|
||||
out, err := cmd.CombinedOutput()
|
||||
if nil != err {
|
||||
return "", fmt.Errorf("\nUnexpected Error\n\n"+
|
||||
"Please open an issue at https://git.rootprojects.org/root/go-gitver/issues/new \n"+
|
||||
"Please include the following:\n\n"+
|
||||
"Command: %s\n"+
|
||||
"Output: %s\n"+
|
||||
"Error: %s\n"+
|
||||
"\nPlease and Thank You.\n\n", strings.Join(args, " "), out, err)
|
||||
}
|
||||
return strings.TrimSpace(string(out)), nil
|
||||
}
|
||||
|
||||
func semVer(desc string) (string, error) {
|
||||
if exactVer.MatchString(desc) {
|
||||
// v1.0.0
|
||||
return strings.TrimPrefix(desc, "v"), nil
|
||||
}
|
||||
|
||||
if !gitVer.MatchString(desc) {
|
||||
return "", nil
|
||||
}
|
||||
|
||||
// (v1.0).(0)(-(1))(-(g0000000))(-(dirty))
|
||||
vers := gitVer.FindStringSubmatch(desc)
|
||||
patch, err := strconv.Atoi(vers[2])
|
||||
if nil != err {
|
||||
return "", fmt.Errorf("\nUnexpected Error\n\n"+
|
||||
"Please open an issue at https://git.rootprojects.org/root/go-gitver/issues/new \n"+
|
||||
"Please include the following:\n\n"+
|
||||
"git description: %s\n"+
|
||||
"RegExp: %#v\n"+
|
||||
"Error: %s\n"+
|
||||
"\nPlease and Thank You.\n\n", desc, gitVer, err)
|
||||
}
|
||||
|
||||
// v1.0.1-pre1
|
||||
// v1.0.1-pre1+g0000000
|
||||
// v1.0.1-pre0+dirty
|
||||
// v1.0.1-pre0+g0000000-dirty
|
||||
if "" == vers[4] {
|
||||
vers[4] = "0"
|
||||
}
|
||||
ver := fmt.Sprintf("%s.%d-pre%s", vers[1], patch+1, vers[4])
|
||||
if "" != vers[6] || "dirty" == vers[8] {
|
||||
ver += "+"
|
||||
if "" != vers[6] {
|
||||
ver += vers[6]
|
||||
if "" != vers[8] {
|
||||
ver += "-"
|
||||
}
|
||||
}
|
||||
ver += vers[8]
|
||||
}
|
||||
|
||||
return strings.TrimPrefix(ver, "v"), nil
|
||||
}
|
||||
|
||||
func gitTimestamp(desc string) (time.Time, error) {
|
||||
// Other options:
|
||||
//
|
||||
// Commit Date
|
||||
// git log -1 --format=%cd --date=format:%Y-%m-%dT%H:%M:%SZ%z
|
||||
//
|
||||
// Author Date
|
||||
// git log -1 --format=%ad --date=format:%Y-%m-%dT%H:%M:%SZ%z
|
||||
//
|
||||
// I think I chose this because it would account for dirty-ness better... maybe?
|
||||
args := []string{
|
||||
"git",
|
||||
"show", desc,
|
||||
"--format=%cd",
|
||||
"--date=format:%Y-%m-%dT%H:%M:%SZ%z",
|
||||
"--no-patch",
|
||||
}
|
||||
cmd := exec.Command(args[0], args[1:]...)
|
||||
out, err := cmd.CombinedOutput()
|
||||
if nil != err {
|
||||
// a dirty desc was probably used
|
||||
return time.Time{}, err
|
||||
}
|
||||
return time.Parse(time.RFC3339, strings.TrimSpace(string(out)))
|
||||
}
|
||||
2
go.mod
2
go.mod
@ -1,3 +1,3 @@
|
||||
module git.rootprojects.org/root/go-gitver/v2
|
||||
module git.rootprojects.org/root/go-gitver
|
||||
|
||||
go 1.12
|
||||
|
||||
@ -3,7 +3,7 @@ package main
|
||||
// use recently generated version info as a fallback
|
||||
// for when git isn't present (i.e. go run <url>)
|
||||
func init() {
|
||||
commit = "37c1fd4b5694fd62c9f0d6ad1df47d938accbeec"
|
||||
version = "2.0.0-pre1-dirty"
|
||||
date = "2020-10-10T16:05:59-06:00"
|
||||
GitRev = "9f05e2304ccd40ac8a6b6bdba176942b475e272f"
|
||||
GitVersion = "v1.1.0"
|
||||
GitTimestamp = "2019-06-21T00:01:09-06:00"
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user