[pkg/ottl] Add status header to readme (#27896)

cmd/githubgen/main.go

@@ -118,7 +118,8 @@ type DependabotData struct {
 
 func makePriority(status *Status) int {
 	// not an internal component such as pkg/**, and no distributions:
-	if len(status.Distributions) == 0 && status.Class != "" {
+	if (status.Class == "receiver" || status.Class == "processor" || status.Class == "exporter" || status.Class == "connector" || status.Class == "extension" || status.Class == "cmd") &&
+		len(status.Distributions) == 0 && status.Class != "" {
 		return 1
 	}
 	// start with a score of 2

cmd/mdatagen/main.go

@@ -56,9 +56,11 @@ func run(ymlPath string) error {
 		return fmt.Errorf("unable to create output directory %q: %w", codeDir, err)
 	}
 	if md.Status != nil {
-		if err = generateFile(filepath.Join(tmplDir, "status.go.tmpl"),
-			filepath.Join(codeDir, "generated_status.go"), md); err != nil {
-			return err
+		if md.Status.Class != "cmd" && md.Status.Class != "pkg" {
+			if err = generateFile(filepath.Join(tmplDir, "status.go.tmpl"),
+				filepath.Join(codeDir, "generated_status.go"), md); err != nil {
+				return err
+			}
 		}
 
 		if _, err = os.Stat(filepath.Join(ymlDir, "README.md")); err == nil {

cmd/mdatagen/metadata-schema.yaml

@@ -7,7 +7,7 @@ parent: string
 # Required for components (Optional for subcomponents): A high-level view of the development status and use of this component
 status:
   # Required: The class of the component (For example receiver)
-  class: <receiver|processor|exporter|connector|extension>
+  class: <receiver|processor|exporter|connector|extension|cmd|pkg>
   # Required: The stability of the component - See https://github.com/open-telemetry/opentelemetry-collector#stability-levels
   stability:
     development: [<metrics|traces|logs|traces_to_metrics|metrics_to_metrics|logs_to_metrics|extension>]

cmd/mdatagen/templates/readme.md.tmpl

@@ -11,7 +11,7 @@
 {{- $idx = inc $idx }}
 {{- end }}
 {{- end}}
-{{- if ne $class "cmd" }}
+{{- if and (ne $class "cmd") (ne $class "pkg")  }}
 | Distributions | [{{ stringsJoin .Status.SortedDistributions "], [" }}] |
 {{- end }}
 {{- if .Status.Warnings }}

cmd/mdatagen/validate.go

@@ -60,7 +60,7 @@ func (s *Status) validateClass() error {
 	if s.Class == "" {
 		return errors.New("missing class")
 	}
-	if s.Class != "receiver" && s.Class != "processor" && s.Class != "exporter" && s.Class != "connector" && s.Class != "extension" && s.Class != "cmd" {
+	if s.Class != "receiver" && s.Class != "processor" && s.Class != "exporter" && s.Class != "connector" && s.Class != "extension" && s.Class != "cmd" && s.Class != "pkg" {
 		return fmt.Errorf("invalid class: %v", s.Class)
 	}
 	return nil

pkg/ottl/README.md

@@ -1,4 +1,13 @@
 # OpenTelemetry Transformation Language
+<!-- status autogenerated section -->
+| Status        |           |
+| ------------- |-----------|
+| Stability     | [alpha]: traces, metrics, logs   |
+| Issues        | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aopen%20label%3Apkg%2Fottl%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Apkg%2Fottl) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Apkg%2Fottl%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Apkg%2Fottl) |
+| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner)    | [@TylerHelmuth](https://www.github.com/TylerHelmuth), [@kentquirk](https://www.github.com/kentquirk), [@bogdandrutu](https://www.github.com/bogdandrutu), [@evan-bradley](https://www.github.com/evan-bradley) |
+
+[alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
+<!-- end autogenerated section -->
 
 The OpenTelemetry Transformation Language is a language for transforming open telemetry data based on the [OpenTelemetry Collector Processing Exploration](https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/processing.md).
 

pkg/ottl/doc.go

@@ -0,0 +1,6 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+//go:generate mdatagen metadata.yaml
+
+package ottl // import "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl"

pkg/ottl/metadata.yaml

@@ -1,3 +1,8 @@
+type: ottl
+
 status:
+  class: pkg
+  stability:
+    alpha: [ traces, metrics, logs ]
   codeowners:
     active: [TylerHelmuth, kentquirk, bogdandrutu, evan-bradley]