version-go/ldflags
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Proper readme info.

Browse Source
This commit is contained in:
Alex 2020-10-04 21:04:31 +02:00
parent 354460fdc9
commit 12990ad2e2
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,2 +1,20 @@
# ldflags # ldflags package
Package to store on-build extra information: version(tag), build hash, build time Package to store on-build extra information: version(tag), build hash, build time
## Usage
Add this package as dependency to YOUR package:
```bash
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'" .
```
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)'" .
```
will store current latest tag, commit hash and build time.