Add `commit_hash` field to `GetInfo` response #1034

ViktorTigerstrom · 2025-04-14T16:28:19Z

Mimics the behaviour of loop pull 914 (lightninglabs/loop#914), but for litd.

This change adds a new field commit_hash field to the GetInfo response, which will contain the full commit hash of the commit that LiT release binary build was based on. If the build had uncommitted changes, the commit_hash field will contain the most recent commit hash, suffixed by "-dirty".

The contents of version field of the GetInfo response is also will also be changed, so that the it'll only include the litd version, and not the commit_hash/tag.

A commit_hash field is also added to the --version output, so which will always contains the full commit hash of the latest commit (with no suffix even on dirty builds).

Note to reviewers:
Just to ensure that this doesn't break the reproducible build across different hosts:
Could you please create a local tag on top of this:

git tag -s v123456789.123456789.123456789-alpha
And build the release with make docker-release tag=v123456789.123456789.123456789-alpha if you're on mac, or make release tag=v123456789.123456789.123456789-alpha with the correct GO version if you're on Linux.
Then verify that the sha256 output for the ./lightning-terminal-v123456789.123456789.123456789-alpha/manifest-v123456789.123456789.123456789-alpha.txt file is: e9bc6a43642d7ae679f1f2bd809c3a517cefc0bddb32beee5e990fc60bd75783

ViktorTigerstrom · 2025-04-14T16:33:47Z

litrpc/proxy.proto

@@ -54,4 +54,7 @@ message GetInfoRequest {
 message GetInfoResponse {
    // The version of the LiTd software that the node is running.
    string version = 1;
+
+    // The git commit hash of the litd binary.
+    string commit_hash = 2;


Let me know if you think commit would be a more suitable name for this, as the contents may be the tag rather than a commit hash. But opted for this naming as it then mimics the loop getinfo response :)

Staying consistent is probably better, I would have chosen "revision" I guess.

bitromortac

LGTM, nice ⚡

edit: will still check the build
edit2: reproduced the build 🎉

bitromortac · 2025-04-15T09:04:38Z

litrpc/proxy.proto

@@ -54,4 +54,7 @@ message GetInfoRequest {
 message GetInfoResponse {
    // The version of the LiTd software that the node is running.
    string version = 1;
+
+    // The git commit hash of the litd binary.
+    string commit_hash = 2;


Staying consistent is probably better, I would have chosen "revision" I guess.

version.go

ellemouton

I guess I dont love the "it's sometimes this but then sometimes that" part.

Cant we just leave "Commit" as it is (to not change behaviour there) but then add "Commit_hash" which is always the revision hash no matter what?

lightninglabs-deploy · 2025-04-30T08:47:58Z

@ViktorTigerstrom, remember to re-request review from reviewers when ready

ViktorTigerstrom · 2025-05-02T08:13:39Z

Thanks for the reviews!

I've updated the PR to address the reviews, by instead adding a tag and a commit_hash field to the GetInfo response.
The tag field will be set to the Git tag that the LiT release binary build was based on. If the build was not based on a clean tagged commit, this field will contain the most recent tag suffixed by the commit hash, and/or a "-dirty" suffix (i.e. the same behaviour as the old "-Commit=" part in the old GetInfo response).

The commit_hash field will contain the full commit hash of the commit that LiT release binary build was based on.

The contents of the version field in the GetInfo response has also been updated to only include the semantic version number of the LiT release, following the semantic versioning 2.0.0 spec (http://semver.org/).

@bitromortac & @ellemouton, can you please check the updates, and check if you think the outputs of the litcli getinfo and litcli --version commands makes sense? If you do, I'll proceed to communicate the changes to the loop team and coordinate to and ensure that we try to follow the same standard for all daemons.

bitromortac

LGTM, tACK 🎉

ellemouton

Left some comments, let me know your thoughts :)

ellemouton · 2025-05-06T10:50:30Z

version.go

 var Commit string

+// GitCommitHash stores the current git commit hash of this build. This should
+// be set using the -ldflags during compilation.
+var GitCommitHash string


suggest just "CommitHash"

ellemouton · 2025-05-06T10:52:12Z

version.go

+// CommitHash returns the git commit hash of the current build.
+func CommitHash() string {
+	return GitCommitHash
+}
+
+// CommitTag returns the git tag of the current build.
+func CommitTag() string {
+	return Commit
+}


why are these functions? I'd say just use the globals directly. The reason Version is a function is cause it does other stuff too

version.go

docs/release-notes/release-notes-0.14.2.md

ellemouton · 2025-05-06T11:00:57Z

litrpc/proxy.proto

+    // The Git commit hash the LiTd binary build was based on.
+    string commit_hash = 3;


perhaps the MVP here is to just add this commit_hash field and leave out the tag for now? afaiu, the initial request was just about consistently getting the commit?

Add the `commit_hash` field to the GetInfoResponse. The `commit_hash` field will contain the most recent commit_hash that the build was based on. If the build had uncommitted changes, this field will contain the most recent commit hash, suffixed by "-dirty". The semantics of the `version` field is also updated to always contain the most recent semantic version of the litd node, following the semantic versioning 2.0.0 spec (http://semver.org/).

The `commit_hash` field will contain the full commit hash of the commit that build was based on.

ViktorTigerstrom · 2025-05-13T10:35:21Z

Updated the PR to address feedback we discussed offline:

In general, this PR has been updated so that:
A commit_hash field has been added to the GetInfo response. The commit_hash field will contain the full commit hash of the commit that LiT release binary build was based on. If the build had uncommitted changes, the commit_hash field will contain the most recent commit hash, suffixed by "-dirty".

The contents of the version field in the GetInfo response has also been updated to only include the semantic version number of the LiT release, following the semantic versioning 2.0.0 spec (http://semver.org/).

Additionally, a commit_hash field has been added to the --version output. The commit_hash field will contain the full commit hash of the commit that LiT release binary build was based on and will never be suffixed by "-dirty", even if the build was dirty.

ViktorTigerstrom · 2025-05-13T10:39:10Z

Makefile

@@ -69,6 +70,8 @@ make_ldflags = $(2) -X $(LND_PKG)/build.Commit=lightning-terminal-$(COMMIT) \
 	-X $(LND_PKG)/build.RawTags=$(shell echo $(1) | sed -e 's/ /,/g') \


Note that we do not change the:
$(LND_PKG)/build.Commit=lightning-terminal-$(COMMIT)

above here, so that the Commit in the getinfo response through lncli remains the same. I think it doesn't make sense to change this until we also change the output of getinfo in lnd.

ellemouton

lgtm!

ViktorTigerstrom changed the title ~~2025 04 include commit hash~~ Add commit_hash field to GetInfo response Apr 14, 2025

ViktorTigerstrom commented Apr 14, 2025

View reviewed changes

ViktorTigerstrom requested review from ellemouton and bitromortac April 14, 2025 17:45

bitromortac approved these changes Apr 15, 2025

View reviewed changes

ellemouton reviewed Apr 16, 2025

View reviewed changes

levmi assigned ViktorTigerstrom Apr 17, 2025

ViktorTigerstrom force-pushed the 2025-04-include-commit-hash branch 2 times, most recently from 90882c6 to 49af0b0 Compare May 2, 2025 08:06

ViktorTigerstrom requested review from ellemouton and bitromortac May 2, 2025 08:13

ViktorTigerstrom changed the title ~~Add commit_hash field to GetInfo response~~ Add tag & commit_hash field to GetInfo response May 2, 2025

bitromortac approved these changes May 2, 2025

View reviewed changes

ellemouton reviewed May 6, 2025

View reviewed changes

ViktorTigerstrom added 3 commits May 13, 2025 12:27

terminal: add commit_hash to --version output

4edaed4

The `commit_hash` field will contain the full commit hash of the commit that build was based on.

docs: Add release notes

59ecb77

ViktorTigerstrom force-pushed the 2025-04-include-commit-hash branch from 49af0b0 to 59ecb77 Compare May 13, 2025 10:29

ViktorTigerstrom changed the title ~~Add tag & commit_hash field to GetInfo response~~ Add commit_hash field to GetInfo response May 13, 2025

ViktorTigerstrom requested a review from ellemouton May 13, 2025 10:35

ViktorTigerstrom commented May 13, 2025

View reviewed changes

ellemouton requested a review from bitromortac May 13, 2025 13:04

ellemouton approved these changes May 14, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `commit_hash` field to `GetInfo` response #1034

Add `commit_hash` field to `GetInfo` response #1034

ViktorTigerstrom commented Apr 14, 2025 •

edited

Loading

ViktorTigerstrom Apr 14, 2025

bitromortac Apr 15, 2025

bitromortac left a comment •

edited

Loading

bitromortac Apr 15, 2025

ellemouton left a comment

lightninglabs-deploy commented Apr 30, 2025

ViktorTigerstrom commented May 2, 2025

bitromortac left a comment

ellemouton left a comment

ellemouton May 6, 2025

ellemouton May 6, 2025

ellemouton May 6, 2025

ViktorTigerstrom commented May 13, 2025

ViktorTigerstrom May 13, 2025 •

edited

Loading

ellemouton left a comment

		// The Git commit hash the LiTd binary build was based on.
		string commit_hash = 3;

		@@ -69,6 +70,8 @@ make_ldflags = $(2) -X $(LND_PKG)/build.Commit=lightning-terminal-$(COMMIT) \
		-X $(LND_PKG)/build.RawTags=$(shell echo $(1) \| sed -e 's/ /,/g') \

Add commit_hash field to GetInfo response #1034

Are you sure you want to change the base?

Add commit_hash field to GetInfo response #1034

Conversation

ViktorTigerstrom commented Apr 14, 2025 • edited Loading

ViktorTigerstrom Apr 14, 2025

Choose a reason for hiding this comment

bitromortac Apr 15, 2025

Choose a reason for hiding this comment

bitromortac left a comment • edited Loading

Choose a reason for hiding this comment

bitromortac Apr 15, 2025

Choose a reason for hiding this comment

ellemouton left a comment

Choose a reason for hiding this comment

lightninglabs-deploy commented Apr 30, 2025

ViktorTigerstrom commented May 2, 2025

bitromortac left a comment

Choose a reason for hiding this comment

ellemouton left a comment

Choose a reason for hiding this comment

ellemouton May 6, 2025

Choose a reason for hiding this comment

ellemouton May 6, 2025

Choose a reason for hiding this comment

ellemouton May 6, 2025

Choose a reason for hiding this comment

ViktorTigerstrom commented May 13, 2025

ViktorTigerstrom May 13, 2025 • edited Loading

Choose a reason for hiding this comment

ellemouton left a comment

Choose a reason for hiding this comment

Add `commit_hash` field to `GetInfo` response #1034

Add `commit_hash` field to `GetInfo` response #1034

ViktorTigerstrom commented Apr 14, 2025 •

edited

Loading

bitromortac left a comment •

edited

Loading

ViktorTigerstrom May 13, 2025 •

edited

Loading