config: Prepare module for release (#4541)

open-telemetry · Nov 10, 2023 · c1ac303 · c1ac303
1 parent fe68fe9
commit c1ac303
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 32 deletions.
diff --git a/config/README.md b/config/README.md
diff --git a/config/config.go b/config/config.go
@@ -72,3 +72,10 @@ func WithOpenTelemetryConfiguration(cfg OpenTelemetryConfiguration) Configuratio
 		return c
 	})
 }
+
+// TODO: implement parsing functionality:
+// - https://github.com/open-telemetry/opentelemetry-go-contrib/issues/4373
+// - https://github.com/open-telemetry/opentelemetry-go-contrib/issues/4412
+
+// TODO: create SDK from the model:
+// - https://github.com/open-telemetry/opentelemetry-go-contrib/issues/4371
diff --git a/config/doc.go b/config/doc.go
@@ -0,0 +1,7 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+// Package config can be used to parse a configuration file
+// that follows the JSON Schema defined by the OpenTelemetry
+// Configuration schema.
+package config // import "go.opentelemetry.io/contrib/config"
diff --git a/versions.yaml b/versions.yaml
@@ -83,8 +83,11 @@ module-sets:
       - go.opentelemetry.io/contrib/samplers/jaegerremote
       - go.opentelemetry.io/contrib/samplers/jaegerremote/example
       - go.opentelemetry.io/contrib/samplers/probability/consistent
+  experimental-config:
+    version: v0.1.0
+    modules:
+      - go.opentelemetry.io/contrib/config
 excluded-modules:
-  - go.opentelemetry.io/contrib/config
   - go.opentelemetry.io/contrib/instrgen
   - go.opentelemetry.io/contrib/instrgen/driver
   - go.opentelemetry.io/contrib/instrgen/testdata/interface