feat(version): append commit hash on build via ldflags #342
Conversation
|
@guergabo based on all the discussions on the other two PRs, IMO this will work. Although the nix part has to be checked as I'm not too familiar with nix syntax. |
khos2ow
force-pushed
the
version-cmd
branch
2 times, most recently
from
d3a0d22 to
264019d
Compare
It standardize resonate binary version to: resonate version v<VERSION>[-<PRE_RELEASE>-<TIMESTAMP>][ COMMIT_HASH] <GOOS>/<GOARCH> where: - `VERSION`: the release version - `PRE_RELEASE`: can be any arbitrary string, e.g. `alpha`, `beta`, `rc.1`, etc - `TIMESTAMP`: the yyyymmdd of build IF this is not a GA release - `COMMIT_HASH`: short revision IF this is a GA release - `GOOS`: underlying OS this binary built on - `GOARCH`: underlying Architecture this binary built on This also adds a new `version` subcommand for convenience and to not give an error on `resonate version` for folks with muscle memory for it. Signed-off-by: Khosrow Moossavi <[email protected]>
| @@ -34,7 +34,6 @@ jobs: | |||
| run: | | |||
| # Extract resonate version | |||
| RESONATE_VERSION=$(./resonate -v | awk '{print $3}') | |||
| RESONATE_VERSION="v${RESONATE_VERSION}" | |||
There was a problem hiding this comment.
This will solve the workflow, but I'm not aware of any other breaking change that this might introduce in the broader resonate landscape, if any. Because effectively resonate --version will always have a leading v and tailing <os>/<arch>, if move forward with this PR.
| @@ -88,6 +90,7 @@ | |||
| ldflags = [ | |||
| "-s" | |||
| "-w" | |||
| "-X github.com/resonatehq/resonate/internal/version.commit=$(shortRev)" | |||
There was a problem hiding this comment.
In this case you'll need to use Nix string interpolation like this:
"-X github.com/resonatehq/resonate/internal/version.commit=${shortRev}"
| @@ -77,6 +78,7 @@ | |||
| # The Resonate server | |||
| resonate = pkgs.buildGoApplication rec { | |||
| pname = "resonate"; | |||
| inherit shortRev; | |||
There was a problem hiding this comment.
You can remove this line (you don't need to inherit this value into the derivation function to use it 😄)
|
@khos2ow I've been helping out with the Nix stuff. I left two quick comments that should hopefully get you over the hump here. |
This PR follows up the attempts on #301 and #302.
It standardize resonate binary version to:
resonate version v<VERSION>[-<PRE_RELEASE>-<TIMESTAMP>][ COMMIT_HASH] <GOOS>/<GOARCH>where:
VERSION: the release versionPRE_RELEASE: can be any arbitrary string, e.g.alpha,beta,rc.1, etcTIMESTAMP: the yyyymmdd of build IF this is not a GA releaseCOMMIT_HASH: short revision IF this is a GA releaseGOOS: underlying OS this binary built onGOARCH: underlying Architecture this binary built onThis also adds a new
versionsubcommand for convenience and to not give an error onresonate versionfor folks with muscle memory for it.Two manual intervention is needed for this workflow:
coreVersionininternal/version/version.goto next logical releaseprereleasetoalpha(ordev, or similar) ininternal/version/version.goprerleaseto""ininternal/version/version.gofor GA, or just leave it as is for the restThe rest will be calculated, or generated on the fly.
Fixes: #298