[chore] Add dockerhub metadata with links to readme files (#873)

* add dockerhub full desriptions with links to readme files

Signed-off-by: Moritz Wiesinger <[email protected]>

* adjust descriptions to include distro name

Signed-off-by: Moritz Wiesinger <[email protected]>

---------

Signed-off-by: Moritz Wiesinger <[email protected]>

Author: mowies

cmd/goreleaser/internal/configure.go

@@ -41,11 +41,17 @@ const (
 )
 
 var (
-	baseArchs         = []string{"386", "amd64", "arm", "arm64", "ppc64le", "s390x"}
-	winArchs          = []string{"386", "amd64", "arm64"}
-	winContainerArchs = []string{"amd64"}
-	darwinArchs       = []string{"amd64", "arm64"}
-	k8sArchs          = []string{"amd64", "arm64", "ppc64le", "s390x"}
+	baseArchs                 = []string{"386", "amd64", "arm", "arm64", "ppc64le", "s390x"}
+	winArchs                  = []string{"386", "amd64", "arm64"}
+	winContainerArchs         = []string{"amd64"}
+	darwinArchs               = []string{"amd64", "arm64"}
+	k8sArchs                  = []string{"amd64", "arm64", "ppc64le", "s390x"}
+	dockerHubFullDescriptions = map[string]string{
+		coreDistro:    "https://raw.githubusercontent.com/open-telemetry/opentelemetry-collector/refs/heads/main/README.md",
+		contribDistro: "https://raw.githubusercontent.com/open-telemetry/opentelemetry-collector-contrib/refs/heads/main/README.md",
+		otlpDistro:    "https://raw.githubusercontent.com/open-telemetry/opentelemetry-collector-releases/refs/heads/main/distributions/otelcol-otlp/README.md",
+		k8sDistro:     "https://raw.githubusercontent.com/open-telemetry/opentelemetry-collector-releases/refs/heads/main/distributions/otelcol-k8s/README.md",
+	}
 
 	imageRepos = []string{dockerHub, ghcr}
 
@@ -141,7 +147,7 @@ var (
 		d.containerImageManifests = slices.Concat(
 			newContainerImageManifests(d.name, "linux", k8sArchs, containerImageOptions{}),
 		)
-	}).WithDefaultArchives().WithDefaultChecksum().WithDefaultSigns().WithDefaultDockerSigns().WithDefaultSBOMs().Build()
+	}).WithDefaultArchives().WithDefaultChecksum().WithDefaultSigns().WithDefaultDockerSigns().WithDefaultDockerHubs().WithDefaultSBOMs().Build()
 )
 
 type buildConfig interface {
@@ -285,6 +291,13 @@ func (b *distributionBuilder) WithDefaultDockerSigns() *distributionBuilder {
 	return b
 }
 
+func (b *distributionBuilder) WithDefaultDockerHubs() *distributionBuilder {
+	b.configFuncs = append(b.configFuncs, func(d *distribution) {
+		d.dockerhubs = b.dockerHubs()
+	})
+	return b
+}
+
 func (b *distributionBuilder) dockerSigns() []config.Sign {
 	return []config.Sign{
 		{
@@ -297,6 +310,22 @@ func (b *distributionBuilder) dockerSigns() []config.Sign {
 	}
 }
 
+func (b *distributionBuilder) dockerHubs() []config.DockerHub {
+	return []config.DockerHub{
+		{
+			Images: []string{
+				fmt.Sprintf("%s/%s", dockerHub, imageName(b.dist.name)),
+			},
+			Description: fmt.Sprintf("OpenTelemetry Collector - %s", b.dist.name),
+			FullDescription: config.IncludedMarkdown{
+				FromURL: config.IncludeFromURL{
+					URL: dockerHubFullDescriptions[b.dist.name],
+				},
+			},
+		},
+	}
+}
+
 func (b *distributionBuilder) WithDefaultSBOMs() *distributionBuilder {
 	b.configFuncs = append(b.configFuncs, func(d *distribution) {
 		d.sboms = b.sboms()
@@ -332,6 +361,7 @@ func (b *distributionBuilder) WithPackagingDefaults() *distributionBuilder {
 		WithDefaultNfpms().
 		WithDefaultMSIConfig().
 		WithDefaultSigns().
+		WithDefaultDockerHubs().
 		WithDefaultDockerSigns().
 		WithDefaultSBOMs()
 }
@@ -383,6 +413,7 @@ type distribution struct {
 	containerImageManifests []config.DockerManifest
 	signs                   []config.Sign
 	dockerSigns             []config.Sign
+	dockerhubs              []config.DockerHub
 	sboms                   []config.SBOM
 	checksum                config.Checksum
 }
@@ -413,6 +444,7 @@ func (d *distribution) BuildProject() config.Project {
 		DockerManifests: d.containerImageManifests,
 		Signs:           d.signs,
 		DockerSigns:     d.dockerSigns,
+		DockerHubs:      d.dockerhubs,
 		SBOMs:           d.sboms,
 		Version:         2,
 		Monorepo: config.Monorepo{

distributions/otelcol-contrib/.goreleaser.yaml

@@ -329,3 +329,10 @@ monorepo:
   tag_prefix: v
 partial:
   by: target
+dockerhub:
+  - images:
+      - otel/opentelemetry-collector-contrib
+    description: OpenTelemetry Collector - otelcol-contrib
+    full_description:
+      from_url:
+        url: https://raw.githubusercontent.com/open-telemetry/opentelemetry-collector-contrib/refs/heads/main/README.md

distributions/otelcol-k8s/.goreleaser.yaml

@@ -209,3 +209,10 @@ monorepo:
   tag_prefix: v
 partial:
   by: target
+dockerhub:
+  - images:
+      - otel/opentelemetry-collector-k8s
+    description: OpenTelemetry Collector - otelcol-k8s
+    full_description:
+      from_url:
+        url: https://raw.githubusercontent.com/open-telemetry/opentelemetry-collector-releases/refs/heads/main/distributions/otelcol-k8s/README.md

distributions/otelcol-otlp/.goreleaser.yaml

@@ -304,3 +304,10 @@ monorepo:
   tag_prefix: v
 partial:
   by: target
+dockerhub:
+  - images:
+      - otel/opentelemetry-collector-otlp
+    description: OpenTelemetry Collector - otelcol-otlp
+    full_description:
+      from_url:
+        url: https://raw.githubusercontent.com/open-telemetry/opentelemetry-collector-releases/refs/heads/main/distributions/otelcol-otlp/README.md

distributions/otelcol/.goreleaser.yaml

@@ -324,3 +324,10 @@ monorepo:
   tag_prefix: v
 partial:
   by: target
+dockerhub:
+  - images:
+      - otel/opentelemetry-collector
+    description: OpenTelemetry Collector - otelcol
+    full_description:
+      from_url:
+        url: https://raw.githubusercontent.com/open-telemetry/opentelemetry-collector/refs/heads/main/README.md