Deprecate otelmacaron (#5646)

Towards #5552
open-telemetry · May 23, 2024 · 0df336b · 0df336b
1 parent 00e72a4
commit 0df336b
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -28,6 +28,8 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
   If you would like to become a Code Owner of this module and prevent it from being removed, see [#5549]. (#5644)
 - The `go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho` package is deprecated.
   If you would like to become a Code Owner of this module and prevent it from being removed, see [#5550]. (#5645)
+- The `go.opentelemetry.io/contrib/instrumentation/gopkg.in/macaron.v1/otelmacaron` package is deprecated.
+  If you would like to become a Code Owner of this module and prevent it from being removed, see [#5552]. (#5646)
 
 [#5542]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5542
 [#5543]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5543
@@ -38,6 +40,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 [#5549]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5549
 [#5550]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5550
 [#5551]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5551
+[#5552]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5552
 
 ## [1.27.0/0.52.0/0.21.0/0.7.0/0.2.0] - 2024-05-21
 

diff --git a/instrumentation/gopkg.in/macaron.v1/otelmacaron/doc.go b/instrumentation/gopkg.in/macaron.v1/otelmacaron/doc.go
@@ -5,4 +5,11 @@
 //
 // Currently only the routing of a received message can be instrumented. To do
 // it, use the Middleware function.
+//
+// Deprecated: otelmacaron has no Code Owner.
+// After August 21, 2024, it may no longer be supported and may stop
+// receiving new releases unless a new Code Owner is found. See
+// [this issue] if you would like to become the Code Owner of this module.
+//
+// [this issue]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5552
 package otelmacaron // import "go.opentelemetry.io/contrib/instrumentation/gopkg.in/macaron.v1/otelmacaron"
diff --git a/instrumentation/gopkg.in/macaron.v1/otelmacaron/example/README.md b/instrumentation/gopkg.in/macaron.v1/otelmacaron/example/README.md
@@ -0,0 +1,3 @@
+# gopkg.in/macaron.v1/otelmacaron instrumentation example
+
+:warning: Deprecated: otelmacaron has no Code Owner.
diff --git a/instrumentation/gopkg.in/macaron.v1/otelmacaron/example/go.mod b/instrumentation/gopkg.in/macaron.v1/otelmacaron/example/go.mod
@@ -1,3 +1,4 @@
+// Deprecated: otelmacaron has no Code Owner.
 module go.opentelemetry.io/contrib/instrumentation/gopkg.in/macaron.v1/otelmacaron/example
 
 go 1.21

diff --git a/instrumentation/gopkg.in/macaron.v1/otelmacaron/example/server.go b/instrumentation/gopkg.in/macaron.v1/otelmacaron/example/server.go
@@ -9,7 +9,7 @@ import (
 
 	"gopkg.in/macaron.v1"
 
-	"go.opentelemetry.io/contrib/instrumentation/gopkg.in/macaron.v1/otelmacaron"
+	"go.opentelemetry.io/contrib/instrumentation/gopkg.in/macaron.v1/otelmacaron" // nolint:staticcheck  // deprecated.
 
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/attribute"

diff --git a/instrumentation/gopkg.in/macaron.v1/otelmacaron/go.mod b/instrumentation/gopkg.in/macaron.v1/otelmacaron/go.mod
@@ -1,3 +1,4 @@
+// Deprecated: otelmacaron has no Code Owner.
 module go.opentelemetry.io/contrib/instrumentation/gopkg.in/macaron.v1/otelmacaron
 
 go 1.21

diff --git a/instrumentation/gopkg.in/macaron.v1/otelmacaron/test/doc.go b/instrumentation/gopkg.in/macaron.v1/otelmacaron/test/doc.go
@@ -7,5 +7,12 @@ Package test validates the otelmacaron instrumentation with the default SDK.
 This package is in a separate module from the instrumentation it tests to
 isolate the dependency of the default SDK and not impose this as a transitive
 dependency for users.
+
+Deprecated: otelmacaron has no Code Owner.
+After August 21, 2024, it may no longer be supported and may stop
+receiving new releases unless a new Code Owner is found. See
+[this issue] if you would like to become the Code Owner of this module.
+
+[this issue]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5552
 */
 package test // import "go.opentelemetry.io/contrib/instrumentation/gopkg.in/macaron.v1/otelmacaron/test"
diff --git a/instrumentation/gopkg.in/macaron.v1/otelmacaron/test/go.mod b/instrumentation/gopkg.in/macaron.v1/otelmacaron/test/go.mod
@@ -1,3 +1,4 @@
+// Deprecated: otelmacaron has no Code Owner.
 module go.opentelemetry.io/contrib/instrumentation/gopkg.in/macaron.v1/otelmacaron/test
 
 go 1.21

diff --git a/instrumentation/gopkg.in/macaron.v1/otelmacaron/test/macaron_test.go b/instrumentation/gopkg.in/macaron.v1/otelmacaron/test/macaron_test.go
@@ -13,7 +13,7 @@ import (
 	"github.com/stretchr/testify/require"
 	"gopkg.in/macaron.v1"
 
-	"go.opentelemetry.io/contrib/instrumentation/gopkg.in/macaron.v1/otelmacaron"
+	"go.opentelemetry.io/contrib/instrumentation/gopkg.in/macaron.v1/otelmacaron" // nolint:staticcheck  // deprecated.
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/codes"