Add vcsinfo when building with goreleaser #3993
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This makes sure that the correct package version metadata is included when inspected via `go version -m`. Signed-off-by: Waldemar Quevedo <wally@nats.io>
|
Thanks a lot @wallyqs |
bruth
approved these changes
Mar 27, 2023
Signed-off-by: Waldemar Quevedo <wally@nats.io>
wallyqs
commented
Mar 28, 2023
| @@ -11,8 +11,10 @@ changelog: | |||
| skip: true | |||
|
|
|||
| builds: | |||
| - main: ./main.go | |||
| - main: . | |||
There was a problem hiding this comment.
@philpennock actually this is only what is needed to remove the false positives from trivy / grype. By building as a package rather than the file, then the package itself is not included as a dependency:
before:
# building main.go
go version -m dist/nats-server_darwin_amd64_v1/nats-server
dist/nats-server_darwin_amd64_v1/nats-server: go1.19.5
path command-line-arguments
dep github.com/klauspost/compress v1.16.0 h1:iULayQNOReoYUe+1qtKOqw9CwJv3aNQu8ivo7lw1HU4=
dep github.com/minio/highwayhash v1.0.2 h1:Aak5U0nElisjDCfPSG79Tgzkn2gl66NxOMspRrKnA/g=
dep github.com/nats-io/jwt/v2 v2.3.0 h1:z2mA1a7tIf5ShggOFlR1oBPgd6hGqcDYsISxZByUzdI=
dep github.com/nats-io/nats-server/v2 (devel)
dep github.com/nats-io/nkeys v0.3.0 h1:cgM5tL53EvYRU+2YLXIK0G2mJtK12Ft9oeooSZMA2G8=
dep github.com/nats-io/nuid v1.0.1 h1:5iA8DT8V7q8WK2EScv2padNa/rTESc1KdnPw4TC2paw=
dep go.uber.org/automaxprocs v1.5.1 h1:e1YG66Lrk73dn4qhg8WFSvhF0JuFQF0ERIp4rpuV8Qk=
dep golang.org/x/crypto v0.6.0 h1:qfktjS5LUO+fFKeJXZ+ikTRijMmljikvG68fpMMruSc=
dep golang.org/x/sys v0.5.0 h1:MUK/U/4lj1t1oPg0HfuXDN/Z1wv31ZJ/YcPiGccS4DU=
dep golang.org/x/time v0.3.0 h1:rg5rLMjNzMS1RkNLzCG38eapWhnYLFYXDXj2gOlr8j4=
after:
# installing package (.)
go version -m dist/nats-server_darwin_amd64_v1/nats-server
dist/nats-server_darwin_amd64_v1/nats-server: go1.19.5
path github.com/nats-io/nats-server/v2
mod github.com/nats-io/nats-server/v2 (devel)
dep github.com/klauspost/compress v1.16.0 h1:iULayQNOReoYUe+1qtKOqw9CwJv3aNQu8ivo7lw1HU4=
dep github.com/minio/highwayhash v1.0.2 h1:Aak5U0nElisjDCfPSG79Tgzkn2gl66NxOMspRrKnA/g=
dep github.com/nats-io/jwt/v2 v2.3.0 h1:z2mA1a7tIf5ShggOFlR1oBPgd6hGqcDYsISxZByUzdI=
dep github.com/nats-io/nkeys v0.3.0 h1:cgM5tL53EvYRU+2YLXIK0G2mJtK12Ft9oeooSZMA2G8=
dep github.com/nats-io/nuid v1.0.1 h1:5iA8DT8V7q8WK2EScv2padNa/rTESc1KdnPw4TC2paw=
dep go.uber.org/automaxprocs v1.5.1 h1:e1YG66Lrk73dn4qhg8WFSvhF0JuFQF0ERIp4rpuV8Qk=
dep golang.org/x/crypto v0.6.0 h1:qfktjS5LUO+fFKeJXZ+ikTRijMmljikvG68fpMMruSc=
dep golang.org/x/sys v0.5.0 h1:MUK/U/4lj1t1oPg0HfuXDN/Z1wv31ZJ/YcPiGccS4DU=
dep golang.org/x/time v0.3.0 h1:rg5rLMjNzMS1RkNLzCG38eapWhnYLFYXDXj2gOlr8j4=
Still the only way for the module to be tagged with v2.9.15 instead of (devel) would be to use some sort of go mod proxy so that go install can tag it as such, but we can consider to do that in another PR/later:
mod github.com/nats-io/nats-server/v2 (devel)
There was a problem hiding this comment.
This appears to be back-to-front. go build and go build . yield the same dependency chain for me. But if I go build main.go and specify a file, then the package disappears from the list?
There was a problem hiding this comment.
Difference between go build main.go and go build .:
# go build main.go :: Adds package itself as a devel dep dependency, omits vcsinfo
$ go build -o nats-server main.go
$ go version -m nats-server
nats-server: go1.19.5
path command-line-arguments
dep github.com/klauspost/compress v1.16.0 h1:iULayQNOReoYUe+1qtKOqw9CwJv3aNQu8ivo7lw1HU4=
dep github.com/minio/highwayhash v1.0.2 h1:Aak5U0nElisjDCfPSG79Tgzkn2gl66NxOMspRrKnA/g=
dep github.com/nats-io/jwt/v2 v2.3.0 h1:z2mA1a7tIf5ShggOFlR1oBPgd6hGqcDYsISxZByUzdI=
>> dep github.com/nats-io/nats-server/v2 (devel) << trips up vulnerability scanners
dep github.com/nats-io/nkeys v0.3.0 h1:cgM5tL53EvYRU+2YLXIK0G2mJtK12Ft9oeooSZMA2G8=
dep github.com/nats-io/nuid v1.0.1 h1:5iA8DT8V7q8WK2EScv2padNa/rTESc1KdnPw4TC2paw=
dep go.uber.org/automaxprocs v1.5.1 h1:e1YG66Lrk73dn4qhg8WFSvhF0JuFQF0ERIp4rpuV8Qk=
dep golang.org/x/crypto v0.6.0 h1:qfktjS5LUO+fFKeJXZ+ikTRijMmljikvG68fpMMruSc=
dep golang.org/x/time v0.3.0 h1:rg5rLMjNzMS1RkNLzCG38eapWhnYLFYXDXj2gOlr8j4=
build -compiler=gc
build CGO_ENABLED=1
build CGO_CFLAGS=
build CGO_CPPFLAGS=
build CGO_CXXFLAGS=
build CGO_LDFLAGS=
build GOARCH=arm64
build GOOS=darwin
# Adds vcsinfo, package is not a dependency of itself but mod is tagged with `devel` instead. This does not cause issues with vuln scanners.
$ go build -o nats-server .
$ go version -m nats-server
nats-server: go1.19.5
path github.com/nats-io/nats-server/v2
mod github.com/nats-io/nats-server/v2 (devel)
dep github.com/klauspost/compress v1.16.0 h1:iULayQNOReoYUe+1qtKOqw9CwJv3aNQu8ivo7lw1HU4=
dep github.com/minio/highwayhash v1.0.2 h1:Aak5U0nElisjDCfPSG79Tgzkn2gl66NxOMspRrKnA/g=
dep github.com/nats-io/jwt/v2 v2.3.0 h1:z2mA1a7tIf5ShggOFlR1oBPgd6hGqcDYsISxZByUzdI=
dep github.com/nats-io/nkeys v0.3.0 h1:cgM5tL53EvYRU+2YLXIK0G2mJtK12Ft9oeooSZMA2G8=
dep github.com/nats-io/nuid v1.0.1 h1:5iA8DT8V7q8WK2EScv2padNa/rTESc1KdnPw4TC2paw=
dep go.uber.org/automaxprocs v1.5.1 h1:e1YG66Lrk73dn4qhg8WFSvhF0JuFQF0ERIp4rpuV8Qk=
dep golang.org/x/crypto v0.6.0 h1:qfktjS5LUO+fFKeJXZ+ikTRijMmljikvG68fpMMruSc=
dep golang.org/x/time v0.3.0 h1:rg5rLMjNzMS1RkNLzCG38eapWhnYLFYXDXj2gOlr8j4=
build -compiler=gc
build CGO_ENABLED=1
build CGO_CFLAGS=
build CGO_CPPFLAGS=
build CGO_CXXFLAGS=
build CGO_LDFLAGS=
build GOARCH=arm64
build GOOS=darwin
build vcs=git
build vcs.revision=1281ca690c8fe396f4075ac4aff20f14a18362ba
build vcs.time=2023-03-28T15:16:33Z
build vcs.modified=true
wallyqs
changed the title
philpennock
approved these changes
Mar 28, 2023
| @@ -11,8 +11,10 @@ changelog: | |||
| skip: true | |||
|
|
|||
| builds: | |||
| - main: ./main.go | |||
| - main: . | |||
There was a problem hiding this comment.
This appears to be back-to-front. go build and go build . yield the same dependency chain for me. But if I go build main.go and specify a file, then the package disappears from the list?
|
@wallyqs Is there any release scheduled for this? |
|
Thanks alot for these changes. :) @wallyqs |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently in Go, a release that is built via
go buildwill always be labeled with its version as being(devel)(even if building from the git tag commit):go version -m /usr/local/bin/nats-server | grep nats-server/v2 dep github.com/nats-io/nats-server/v2 (devel)And in order to include the release version in the binary it has to be built using
go install:go install github.com/nats-io/nats-server/v2@v2.9.15 | grep nats-server/v2 path github.com/nats-io/nats-server/v2 mod github.com/nats-io/nats-server/v2 v2.9.15 h1:MuwEJheIwpvFgqvbs20W8Ish2azcygjf4Z0liVu2I4c=We usegoreleaserfor the release and building for many platforms, so in order to enable adding the correct version metadata, we need to enable building via the proxy which works as follows:https://goreleaser.com/cookbooks/build-go-modules/
Updated: Removed building with the go mod proxy and just changed to build the package which is going to be enough to fix the trivy / grype issues.
This also adds the
trimpathbuild flag to remove the filesystem paths from where the binary was built.This should help reducing some of the false positives from vulnerability scanners which are not matching with the proper version of the binary as in #3992 with a
malformed versionwarning.Fixes #3992