Print the revision within the markdown reports

Part of #207
symflower · Jul 10, 2024 · bc02431 · bc02431
1 parent bca2286
commit bc02431
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/cmd/eval-dev-quality/cmd/evaluate.go b/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",

diff --git a/evaluate/report/markdown.go b/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
 

diff --git a/evaluate/report/markdown_test.go b/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