Container images: show git commit hash in --version output when built on GitHub Actions #260
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
docker/build-push-action actually does not use the local checkout but instead simply passes the repo URL to BuildKit which then checks out the repo itself. Thus, that call of actions/checkout is unnecessary and is removed.
By default, BuildKit checks out the git repository but does not include the .git directory in the build context. This then prevents go build from embedding the commit hash into the binary which we want to include in the --version output. This behavior can be changed by setting a build argument and fixes our --version output.
|
The current job output for this PR shows that the git commit hash is now included: |
julianbrost
force-pushed
the
container-commit-hash
branch
from
b7281ce
to
d05af24
Compare
yhabteab
approved these changes
Jul 25, 2024
|
Verified to be fixed in the version now on Docker Hub: $ docker pull icinga/icinga-notifications:main
main: Pulling from icinga/icinga-notifications
c6a83fedfae6: Already exists
89b1561333ae: Pull complete
177053750f25: Pull complete
f342dffd92c5: Pull complete
e6689d797880: Pull complete
Digest: sha256:17450231efc68e5862dbd73d3e415b32c7c9f74272d1fb1affeb14d3dffd4efe
Status: Downloaded newer image for icinga/icinga-notifications:main
docker.io/icinga/icinga-notifications:main
$ docker run --rm -it icinga/icinga-notifications:main icinga-notifications --version
Icinga Notifications version: 0.1.0-g8102c77
Build information:
Go version: go1.22.5 (linux, amd64)
Git commit: 8102c7797364a1f184526a19083220fa7d7a46c9
System information:
Platform: Alpine Linux
Platform version: 3.20.2 |
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.
By default, BuildKit checks out the git repository but does not include the
.gitdirectory in the build context. This then preventsgo buildfrom embedding the commit hash into the binary which we want to include in the--versionoutput. This behavior can be changed by setting a build argument and fixes our--versionoutput.This also implies that the use of
actions/checkoutwas actually redundant and I've removed it in a separate commit.The changes to the
Dockerfile(b7281ce) are intended to demonstrate that this actually fixes the issue. After an initial review, I'd remove that commit, wait for a final approval and then merge it.fixes #257