skeema / skeema / 18391899572

92%

Build Type

push

github

Committed by evanelias

Commit Message

version command: populate from main module BuildInfo for source builds

This commit modifies how Skeema self-reports its version number string when
using a Community Edition binary that was locally built from source, rather
than a prebuilt binary release.

The version information for a Skeema binary can be displayed by running
either `skeema version` or `skeema --version`. For prebuilt releases, this
command uses information supplied by GoReleaser. However, when building from
source, previously this only displayed the most recent hardcoded version
string, followed by "(snapshot build from source)".

In Go 1.24+, the runtime/debug package provides a way to obtain a Go-style
version string based on the most recent tag, current commit sha, and dirty
(uncommitted change) status. Since Skeema's minimum Go version is now 1.24,
that debug information is leveraged here to provide more detailed version
output for binaries that were built from source.

In cases where Skeema is compiled without Go module support, this extended
information is unavailable. This may affect builds from OS package managers.
If desired, package manager maintainers can optionally build the `skeema`
binary using Golang ldflags -X main.commit=... -X main.date=... to populate
these fields similar to GoReleaser's approach. Dates must be supplied in
RFC3339 format.

As an aside, package manager maintainers are also asked to please review the
latest go.mod, and ensure that the dependency list in your package repo is
still accurate. Several previously-imported modules are no longer needed and
were removed from Skeema's go.mod over the past few years, but are still
erroneously listed as being dependencies in some OS package repositories.

Run Details

11 of 13 new or added lines in 2 files covered. (84.62%)

1 existing line in 1 file now uncovered.

10818 of 11646 relevant lines covered (92.89%)

1.11 hits per line