Adds comprehensive build versioning support by Vikramarjuna · Pull Request #217 · Cloud-Foundations/Dominator

Vikramarjuna · 2026-01-29T08:55:53Z

Summary

Adds build versioning to all binaries. Version, git origin, branch, and commits behind upstream are captured at build time into an embedded BUILD_INFO file, combined with VCS info from debug.ReadBuildInfo(), and surfaced via:

-version flag
Startup logs
HTML status page footers

Fork-specific details (origin, branch, commits behind) are shown only when relevant.

Version Format

v0.12.0 — release build (exactly on tag)
v0.12.0-3-gabcdef — dev build (3 commits after tag)
v0.12.0-3-gabcdef-dirty — uncommitted changes

Example

$ domtool -version
domtool v0.12.0-68-gfd5cf75a-dirty
  Commit: fd5cf75a
  Origin: Vikramarjuna/Dominator
  Branch: versioning
  Built:  2026-04-01T06:49:28Z
  Go:     go1.25.5

Build

Use make to build (generates BUILD_INFO automatically):

make all    # or make build-linux, make install-darwin, etc.

rgooch

I would like this PR to be split, with the first PR containing only the minimum to add version information (i.e. remove the workflow and reduce/eliminate changes to the Makefile).

I would prefer we don't impose a requirement to change every command. I think the lib/flags/loadflags package is a convenient place to make a fairly central change.

Finally, instead of injecting compile/link flags, I think it's better to use the embed package.

rgooch · 2026-03-29T16:02:20Z

@@ -0,0 +1 @@
+v0.12.0


Please fetch this from the most recent tag in the repository.

Addressed. Getting the latest tag with versioning format as part of make and injecting to the version file.

rgooch · 2026-03-29T16:03:50Z

+		revision:  "unknown",
+		buildTime: "unknown",
+	}
+


Please delete empty lines in functions. Same comment applies further down.

rgooch · 2026-04-18T18:36:15Z

 )

 func LoadForCli(progName string) error {
+	registerVersionFlag(progName)


Please move this into the impl.go file.

rgooch · 2026-04-18T18:36:47Z

 }

 func LoadForDaemon(progName string) error {
+	registerVersionFlag(progName)


Please move this into the impl.go file.
Cleanest would be to add a loadForDaemon() function to contain this call.

rgooch · 2026-04-18T18:37:37Z

+
 go.work
-go.work.sum
+go.work.sum


Please add missing newline on last line.

rgooch · 2026-04-18T18:40:06Z

+		os.Exit(0)
+		return nil
+	})
+}


Please insert blank line between functions.

rgooch · 2026-04-18T19:03:46Z

+func registerVersionFlag(name string) {
+	flag.BoolFunc("version", "Print version information and exit", func(string) error {
+		info := version.Get()
+		fmt.Printf("%s %s\n", name, info.Version)


Output should be sent to: flag.CommandLine.Output()

rgooch · 2026-04-18T19:08:13Z

+
+// String returns a human-readable version string.
+func (i Info) String() string {
+	return infoString(i)


This is not idiomatic Go. It should call a method.

rgooch · 2026-04-18T19:09:43Z

+
+// Info contains version information for a binary.
+type Info struct {
+	Version       string `json:"version"`


Please remove all the field tags. The convention in this repository is that the JSON field names are the same as the actual field names.

rgooch · 2026-04-18T19:10:44Z

+}
+
+func infoString(i Info) string {
+	return fmt.Sprintf("%s (built: %s)", i.Version, i.BuildDate)


Perhaps here is where the Go version can be inserted.

Added the go version along with other details

rgooch · 2026-04-18T19:13:14Z

-all:
+UPSTREAM_REPO := https://github.com/Cloud-Foundations/Dominator.git
+
+build-info:


This target slows down the time to run make. Are these remote Git operations required? Are there other ways to reduce the time?

I have introduced a flag to fetch the latest SHA from the upstream. The flag is disabled by default. If it is disabled, we will not know how many commits the current branch/fork is behind the upstream. The version info will now show unknown by default and if it is built with the flag enabled it will show either up to date or n commits for the Behind field. Rest of the git operations are run locally and doesn't cause any slowness. These gives information of fork and branch.

rgooch · 2026-04-23T15:38:10Z

+	case "$$raw_origin" in *Cloud-Foundations*) is_fork=false;; *) is_fork=true;; esac; \
+	if [ "$$is_fork" = false ] && [ "$$branch" = "master" ]; then \
+		behind=0; \
+	elif [ -n "$(WITH_UPSTREAM)" ] && \


It would be nice to add a target that does this.

Addressed. Added a new target.

added support versioning the binaries

2d5741e

rgooch requested changes Feb 12, 2026

View reviewed changes

Vikramarjuna and others added 4 commits February 17, 2026 13:19

Merge branch 'Cloud-Foundations:master' into versioning

3076401

added versioning support for the binaries

00ccacb

added versioning support for the binaries

28a3a2c

added versioning support for the binaries

b98ecd2

rgooch requested changes Mar 29, 2026

View reviewed changes

getting the version number from git tag

1221f61

Vikramarjuna changed the title ~~Adds comprehensive build versioning support to inject version information into all binaries at build time using ldflags~~ Adds comprehensive build versioning support Apr 1, 2026

Vikramarjuna and others added 3 commits April 1, 2026 11:39

Merge branch 'master' into versioning

fafb640

getting the version number from git tag

fd5cf75

added origin and branch details to the version info

1b16cce

rgooch requested changes Apr 18, 2026

View reviewed changes

Vikramarjuna Malapati added 2 commits April 22, 2026 16:07

addressed comments

8b42cb4

addressed comments

d9b0968

rgooch approved these changes Apr 23, 2026

View reviewed changes

Vikramarjuna Malapati and others added 2 commits April 24, 2026 20:34

added new target for building with upstream status

0a93028

Merge branch 'Cloud-Foundations:master' into versioning

cc60270

rgooch merged commit f4652cc into Cloud-Foundations:master Apr 24, 2026

		@@ -0,0 +1 @@
		v0.12.0 No newline at end of file

Conversation

Vikramarjuna commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Version Format

Example

Build

Uh oh!

rgooch left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Vikramarjuna commented Jan 29, 2026 •

edited

Loading