internal: apply suggestions from code review

darccio · eliottness · web-flow · commit 3d109862694e · 2024-07-12T16:19:49.000+02:00
Co-authored-by: Eliott Bouhana &lt;47679741+eliottness@users.noreply.github.com&gt;
diff --git a/internal/gitmetadata.go b/internal/gitmetadata.go
@@ -101,7 +101,7 @@ func getTagsFromBinary(readBuildInfo func() (*debug.BuildInfo, bool)) map[string
 	return res
 }
 
-// GetGitMetadataTags returns git metadata tags
+// GetGitMetadataTags returns git metadata tags. Returned map is read-only
 func GetGitMetadataTags() map[string]string {
 	initOnce.Do(initGitMetadataTags)
 	return gitMetadataTags
@@ -117,7 +117,7 @@ func initGitMetadataTags() {
 	}
 }
 
-// RefreshGitMetadataTags reset cached metadata tags
+// RefreshGitMetadataTags reset cached metadata tags. NOT thread-safe, use for testing only
 func RefreshGitMetadataTags() {
 	initGitMetadataTags()
 }

Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ func getTagsFromBinary(readBuildInfo func() (*debug.BuildInfo, bool)) map[string`
`101`	`101`	`return res`
`102`	`102`	`}`
`103`	`103`
`104`		`-// GetGitMetadataTags returns git metadata tags`
	`104`	`+// GetGitMetadataTags returns git metadata tags. Returned map is read-only`
`105`	`105`	`func GetGitMetadataTags() map[string]string {`
`106`	`106`	`initOnce.Do(initGitMetadataTags)`
`107`	`107`	`return gitMetadataTags`
`@@ -117,7 +117,7 @@ func initGitMetadataTags() {`
`117`	`117`	`}`
`118`	`118`	`}`
`119`	`119`
`120`		`-// RefreshGitMetadataTags reset cached metadata tags`
	`120`	`+// RefreshGitMetadataTags reset cached metadata tags. NOT thread-safe, use for testing only`
`121`	`121`	`func RefreshGitMetadataTags() {`
`122`	`122`	`initGitMetadataTags()`
`123`	`123`	`}`