Kamal::Git.version now uses git describe #409
Open
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
djmb
reviewed
Sep 7, 2023
lib/mrsk/configuration.rb
Outdated
|
|
||
| "#{`git rev-parse HEAD`.strip}#{uncommitted_suffix}" | ||
| if system("git describe") | ||
| `git describe --always --dirty='-dirty-#{SecureRandom.hex(8)}` |
There was a problem hiding this comment.
git describe doesn't treat untracked files as dirty, could we check for them and append the dirty- suffix manually?
There was a problem hiding this comment.
Great call out @djmb. I will amend this.
hey-leon
force-pushed
the
improved-git-versioning
branch
from
3d42460
to
2741695
Compare
hey-leon
changed the title
hey-leon
changed the title
|
This has been revised to update the new |
|
need this to be merged, then we can ping the correct container's hostname |
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.
Why change Kamal::Git.version?
Currently container names can get very long with - service, role, destination, sha and even possible uncommited changes. This can make them hard to read or compare.
Looking for feedback before finalising this PR
The tests are not passing but I am wondering if there is interest in this change or maybe an alternative one that would simply shorten the sha - e.g.
git rev-parse --short HEADDescription
Previously Kamal::Git.version used rev-parse to retrieve the current commits full sha. While this works it currently creates a very long version name. This PR changes it to use
git describe, which will use a tag if it exists, suffix with an abberviated commit sha if there are new commits, and lastly suffix it the same as before if their are uncommited changes. Some e.g.Further reading: https://git-scm.com/docs/git-describe