Describe releases as SemVer git tags in the README (closes #226) #231
@@ -13,14 +13,11 @@ The structure of these files can be found
|
|||||||
schema `mfer/mf.proto` for exact field numbers and types. Both are included in
|
schema `mfer/mf.proto` for exact field numbers and types. Both are included in
|
||||||
the [project repository](https://git.eeqj.de/sneak/mfer).
|
the [project repository](https://git.eeqj.de/sneak/mfer).
|
||||||
|
|
||||||
The current version is pre-1.0 and while the repo was published in 2022, there
|
Releases are git tags named by [SemVer](https://semver.org), starting with
|
||||||
has not yet been any versioned release. [SemVer](https://semver.org) will be
|
`v1.0.0`. No file in the tree records a version number. `mfer version` prints
|
||||||
used for releases.
|
the revision the build stamped into the binary, which for `make build` and the
|
||||||
|
Docker image is the output of `git describe` on the checkout they build. A
|
||||||
A version is a git tag, and no file in the tree records a version number.
|
binary built without that stamp, as
|
||||||
`mfer version` prints the revision the build stamped into the binary, which for
|
|
||||||
`make build` and the Docker image is the output of `git describe` on the
|
|
||||||
checkout they build. A binary built without that stamp, as
|
|
||||||
`go install sneak.berlin/go/mfer/cmd/mfer@<tag>` builds it, prints the module
|
`go install sneak.berlin/go/mfer/cmd/mfer@<tag>` builds it, prints the module
|
||||||
version Go records in it instead. A program that imports the `mfer` package
|
version Go records in it instead. A program that imports the `mfer` package
|
||||||
finds the version it was built against in its own build information
|
finds the version it was built against in its own build information
|
||||||
|
|||||||
Reference in New Issue
Block a user