Use the commit date for build metadata #3322
Conversation
Use the date of the latest commit in the working tree during the build process. Previously, the date of the build was generated at runtime blocking the possibility to have reproducible builds.
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## master #3322 +/- ##
==========================================
+ Coverage 73.20% 73.21% +0.01%
==========================================
Files 258 258
Lines 19895 19895
==========================================
+ Hits 14564 14566 +2
+ Misses 4406 4405 -1
+ Partials 925 924 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
It seems to work as you can see from the Build check: I've rebuilt it again today to confirm that the date doesn't change. The 2nd run: /~https://github.com/grafana/k6/actions/runs/6087972451/job/16536142053 |
|
The version printed by @olegbespalov If you fetch this branch what do you get running the command? |
|
|
The build stage says /~https://github.com/grafana/k6/actions/runs/6096099795/job/16540972908?pr=3322 Any idea why? 🤔 |
|
I belive it's because it's a pull request https://stackoverflow.com/questions/68061051/get-commit-sha-in-github-actions |
build-release.sh
Outdated
| @@ -10,7 +10,8 @@ export OUT_DIR="${1-dist}" | |||
| export VERSION=${2:-$(git describe --tags --always --dirty)} | |||
|
|
|||
| # To overwrite the version details, pass something as the third arg. Empty string disables it. | |||
| export VERSION_DETAILS=${3-"$(date -u +"%FT%T%z")/$(git describe --tags --always --long --dirty)"} | |||
| export COMMIT_DATE=$(git log -1 --format=%at $VERSION | { read d ; date -u +"%FT%T%z" -d @"$d" ; }) | |||
There was a problem hiding this comment.
To be honest ... I am kind of for dropping this 🤷
We have the commit - that is all we need. Or we have a really well tagged build - so again the date of the build doesn't really matter.
To be honest I really was hoping that we can get rid of this all together and just rely on ReadBuildInfo, unfortunately go build in practice never populates this (see here for reasons).
So in practice that is not ... possible unless we figure out how to make go install compile. Which works except that:
So ... in theory we can have go install ...; mv $GOBIN/k6 ... somehwere
But this seems ... bad - I currently hope that the 57485 will be fixed 🤞 or go build will be allowed to buildinfo.
Currently if you do go install vs what we have as binary the output is different:
[mstoykov@fedora k6]$ go install go.k6.io/k6@v0.46.0
[mstoykov@fedora k6]$ k6 version
k6 v0.46.0 (v0.46.0, go1.21.1, linux/amd64)
[mstoykov@fedora k6]$ k6.v0.46.0 version
k6 v0.46.0 (2023-08-14T13:23:26+0000/v0.46.0-0-gcbd9e9ad, go1.20.7, linux/amd64)
And to be honest I find our build to be worse 🤷
so .. to reiterate ... can we drop the date at least?
| @@ -10,7 +10,8 @@ export OUT_DIR="${1-dist}" | |||
| export VERSION=${2:-$(git describe --tags --always --dirty)} | |||
|
|
|||
| # To overwrite the version details, pass something as the third arg. Empty string disables it. | |||
| export VERSION_DETAILS=${3-"$(date -u +"%FT%T%z")/$(git describe --tags --always --long --dirty)"} | |||
| export COMMIT_DATE=$(git log -1 --format=%ct $VERSION | { read d ; date -u +"%FT%T%z" -d @"$d" ; }) | |||
There was a problem hiding this comment.
| export COMMIT_DATE=$(git log -1 --format=%ct $VERSION | { read d ; date -u +"%FT%T%z" -d @"$d" ; }) | |
| export COMMIT_DATE=$(git log -1 --format=%ct HEAD | { read d ; date -u +"%FT%T%z" -d @"$d" ; }) |
I feel like this is what you meant ?
You also can just drop HEAD I guess.
|
Closing in favor of #3327 |
What?
Use the date of the latest commit in the working tree during the build process.
Note: GitHub uses the COMMIT DATE and not the AUTHOR DATE as you see in
git logclassic dump.Why?
Previously, the date of the build was generated at runtime blocking the possibility of reproducible builds.
Related PR(s)/Issue(s)
#1996