Merge pull request #5 from version-go/bugs/readme

Fix build vars in doc.
This commit is contained in:
Alex 2020-10-05 20:24:48 +02:00 committed by GitHub
commit 2be6abd636
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -10,11 +10,11 @@ go get github.com/version-go/ldflags
Then on build of YOUR package just add extra:
```bash
go build -ldflags "-X 'github.com/version-go/ldflags.version=0.1.0' -X 'github.com/version-go/ldflags.hash=9e7637c' -X 'github.com/version-go/ldflags.time=Sun Oct 4 20:57:29 CEST 2020'" .
go build -ldflags "-X 'github.com/version-go/ldflags.buildVersion=0.1.0' -X 'github.com/version-go/ldflags.buildHash=9e7637c' -X 'github.com/version-go/ldflags.buildTime=Sun Oct 4 20:57:29 CEST 2020'" .
```
Or do it automatically based on existing git/data:
```bash
go build -ldflags "-X 'github.com/version-go/ldflags.version=$(git describe --abbrev=0 --tags)' -X 'github.com/version-go/ldflags.hash=$(git rev-parse --short HEAD)' -X 'github.com/version-go/ldflags.time=$(date)'" .
go build -ldflags "-X 'github.com/version-go/ldflags.buildVersion=$(git describe --abbrev=0 --tags)' -X 'github.com/version-go/ldflags.buildHash=$(git rev-parse --short HEAD)' -X 'github.com/version-go/ldflags.buildTime=$(date)'" .
```
will store current latest tag, commit hash and build time.