Add the commit revision to binary/reports/docker

.github/workflows/branch.yml

@@ -0,0 +1,15 @@
+name: Branch CI
+
+on:
+  push:
+    branches-ignore:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  docker:
+    name: 'Run docker image building'
+    uses: ./.github/workflows/docker.yml

.github/workflows/docker.yml

@@ -34,3 +34,5 @@ jobs:
           platforms: linux/amd64
           tags: ${{ steps.meta.outputs.tags }}
           push: true
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

Makefile

@@ -10,6 +10,9 @@ export ARGS
 HAVE_CHANGED_FILES := ! git --no-pager diff --exit-code
 HAVE_UNTRACKED_FILES := git ls-files --others --exclude-standard | grep .
 
+export GIT_REVISION := $(shell git rev-parse --short HEAD)
+export GO_LDFLAGS=-X $(PACKAGE_BASE)/evaluate.Revision=$(GIT_REVISION)
+
 ifdef ARGS
 	HAS_ARGS := "1"
 	PACKAGE := $(ARGS)
@@ -41,7 +44,7 @@ help: # Show this help message.
 .PHONY: help
 
 install: # [<Go package] - # Build and install everything, or only the specified package.
-	go install -v $(PACKAGE)
+	go install -v -ldflags="$(GO_LDFLAGS)" $(PACKAGE)
 .PHONY: install
 
 install-all: install install-tools-testing # Install everything for and of this repository.

cmd/eval-dev-quality/cmd/command.go

@@ -9,6 +9,7 @@ import (
 type Command struct {
 	Evaluate     `command:"evaluate" description:"Run an evaluation, by default with all defined models, repositories and tasks."`
 	InstallTools `command:"install-tools" description:"Checks and installs all tools required for the evaluation benchmark."`
+	Version      `command:"version" description:"Display the version information of the binary."`
 }
 
 // Execute executes the root command.

cmd/eval-dev-quality/cmd/command_test.go

@@ -35,7 +35,7 @@ func TestExecute(t *testing.T) {
 
 			ExpectedOutput: bytesutil.StringTrimIndentations(`
 				Usage:
-				  eval-dev-quality [OPTIONS] [evaluate | install-tools]
+				  eval-dev-quality [OPTIONS] [evaluate | install-tools | version]
 
 				Command to manage, update and actually execute the ` + "`" + `eval-dev-quality` + "`" + `
 				evaluation benchmark.
@@ -47,6 +47,7 @@ func TestExecute(t *testing.T) {
 				Available commands:
 				  evaluate       Run an evaluation, by default with all defined models, repositories and tasks.
 				  install-tools  Checks and installs all tools required for the evaluation benchmark.
+				  version        Display the version information of the binary.
 			`),
 		})
 	} else {
@@ -55,7 +56,7 @@ func TestExecute(t *testing.T) {
 
 			ExpectedOutput: bytesutil.StringTrimIndentations(`
 				Usage:
-				  eval-dev-quality [OPTIONS] [evaluate | install-tools]
+				  eval-dev-quality [OPTIONS] [evaluate | install-tools | version]
 
 				Command to manage, update and actually execute the ` + "`" + `eval-dev-quality` + "`" + `
 				evaluation benchmark.
@@ -66,6 +67,7 @@ func TestExecute(t *testing.T) {
 				Available commands:
 				  evaluate       Run an evaluation, by default with all defined models, repositories and tasks.
 				  install-tools  Checks and installs all tools required for the evaluation benchmark.
+				  version        Display the version information of the binary.
 			`),
 		})
 	}

cmd/eval-dev-quality/cmd/evaluate.go

@@ -419,6 +419,7 @@ func (command *Evaluate) evaluateLocal(evaluationContext *evaluate.Context) (err
 	if err := (report.Markdown{
 		DateTime: command.timestamp,
 		Version:  evaluate.Version,
+		Revision: evaluate.Revision,
 
 		CSVPath:       "./evaluation.csv",
 		LogPath:       "./evaluation.log",

cmd/eval-dev-quality/cmd/version.go

@@ -0,0 +1,31 @@
+package cmd
+
+import (
+	"github.com/symflower/eval-dev-quality/evaluate"
+	"github.com/symflower/eval-dev-quality/log"
+)
+
+// Version defines the "version" command.
+type Version struct {
+	// logger holds the logger of the command.
+	logger *log.Logger
+}
+
+var _ SetLogger = (*Version)(nil)
+
+// SetLogger sets the logger of the command.
+func (command *Version) SetLogger(logger *log.Logger) {
+	command.logger = logger
+}
+
+// Execute executes the command.
+func (command *Version) Execute(args []string) (err error) {
+	revision := evaluate.Revision
+	if revision == "" {
+		revision = "development"
+	}
+	command.logger.SetFlags(0) // Remove the timestamp and everything from the log output while still being able to test it.
+	command.logger.Printf("eval-dev-quality version %s - revision %s", evaluate.Version, revision)
+
+	return nil
+}

cmd/eval-dev-quality/cmd/version_test.go

@@ -0,0 +1,19 @@
+package cmd
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/symflower/eval-dev-quality/evaluate"
+	"github.com/symflower/eval-dev-quality/log"
+)
+
+func TestVersionExecute(t *testing.T) {
+	logOutput, logger := log.Buffer()
+
+	Execute(logger, []string{"version"})
+
+	expected := fmt.Sprintf("eval-dev-quality version %s - revision %s", evaluate.Version, "development")
+	assert.Contains(t, logOutput.String(), expected)
+}

evaluate/report/markdown.go

@@ -25,6 +25,8 @@ type Markdown struct {
 	DateTime time.Time
 	// Version holds the version of the evaluation tool.
 	Version string
+	// Revision holds the Git revision of the evaluation tool.
+	Revision string
 
 	// CSVPath holds the path of detailed CSV results.
 	CSVPath string
@@ -71,7 +73,7 @@ var markdownTemplate = template.Must(template.New("template-report").Parse(bytes
 
 	![Bar chart that categorizes all evaluated models.]({{.SVGPath}})
 
-	This report was generated by [DevQualityEval benchmark](https://github.com/symflower/eval-dev-quality) in ` + "`" + `version {{.Version}}` + "`" + `.
+	This report was generated by [DevQualityEval benchmark](https://github.com/symflower/eval-dev-quality) in ` + "`" + `version {{.Version}}` + "`" + ` - ` + "`" + `revision {{.Revision}}` + "`" + `.
 
 	## Results
 

evaluate/report/markdown_test.go

@@ -62,6 +62,7 @@ func TestMarkdownWriteToFile(t *testing.T) {
 		Markdown: Markdown{
 			DateTime: testTime,
 			Version:  "1234",
+			Revision: "abcd",
 
 			CSVPath:       "./file.csv",
 			LogPath:       "./file.log",
@@ -74,7 +75,7 @@ func TestMarkdownWriteToFile(t *testing.T) {
 
 			![Bar chart that categorizes all evaluated models.](./file.svg)
 
-			This report was generated by [DevQualityEval benchmark](https://github.com/symflower/eval-dev-quality) in ` + "`" + `version 1234` + "`" + `.
+			This report was generated by [DevQualityEval benchmark](https://github.com/symflower/eval-dev-quality) in ` + "`" + `version 1234` + "`" + ` - ` + "`" + `revision abcd` + "`" + `.
 
 			## Results
 
@@ -101,6 +102,7 @@ func TestMarkdownWriteToFile(t *testing.T) {
 		Markdown: Markdown{
 			DateTime: testTime,
 			Version:  "1234",
+			Revision: "abcd",
 
 			CSVPath:       "./file.csv",
 			LogPath:       "./file.log",
@@ -121,7 +123,7 @@ func TestMarkdownWriteToFile(t *testing.T) {
 
 			![Bar chart that categorizes all evaluated models.](./file.svg)
 
-			This report was generated by [DevQualityEval benchmark](https://github.com/symflower/eval-dev-quality) in ` + "`" + `version 1234` + "`" + `.
+			This report was generated by [DevQualityEval benchmark](https://github.com/symflower/eval-dev-quality) in ` + "`" + `version 1234` + "`" + ` - ` + "`" + `revision abcd` + "`" + `.
 
 			## Results
 

evaluate/version.go

@@ -2,3 +2,6 @@ package evaluate
 
 // Version holds the current version of the evaluation benchmark.
 var Version = "0.5.0"
+
+// Revision holds the Git revision of the current build.
+var Revision string