[mdatagen] Add optional display_name field to metadata.yaml (#14115)

## Description

This PR adds an optional `display_name` field to metadata.yaml for
human-readable component names, as requested in #14114.

## Changes

- Added `display_name` field to metadata-schema.yaml
- Updated Metadata struct to include DisplayName field
- Implemented automatic capitalization of type field when display_name
not provided
- Modified readme.md.tmpl to generate README titles from display_name
- Fixed unused import issue in config_test.go.tmpl
- Added test cases for display_name handling
- Regenerated internal test code and README files

## Implementation

Following the implementation guide from @mx-psi:

1. Added the field to the Metadata struct
2. Added title generation section to readme.md.tmpl template
3. Added comprehensive tests covering both explicit and default display
names
4. Verified functionality with OTLP receiver (tested locally)

## Behavior

- When `display_name` is set in metadata.yaml, it will be used as the
README title
- When not set, the component type will be automatically capitalized
(e.g., "otlp" becomes "Otlp")
- Fully backward compatible - existing components without display_name
continue to work

## Testing

- Unit tests added for display_name loading
- Default value generation tested
- Generated test files verified
- CI checks passing (gotidy, misspell, multimod-verify, crosslink)

Fixes #14114

Co-authored-by: SteveYi <[email protected]>

---------

Co-authored-by: Pablo Baeyens <[email protected]>

Author: thc1006

.chloggen/add-display-name-14114.yaml

@@ -0,0 +1,28 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: cmd/mdatagen
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add optional `display_name` and `description` fields to metadata.yaml for human-readable component names
+
+# One or more tracking issues or pull requests related to the change
+issues: [14114]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext: |
+  The `display_name` field allows components to specify a human-readable name in metadata.yaml.
+  When provided, this name is used as the title in generated README files.
+  The `description` field allows components to include a brief description in generated README files.
+
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [user]

.github/workflows/utils/cspell.json

@@ -322,6 +322,7 @@
       "myreceiver",
       "myrepo",
       "mysite",
+      "nodisplayname",
       "nonclobbering",
       "nopexporter",
       "nopreceiver",
@@ -458,6 +459,7 @@
       "testcomponents",
       "testconverter",
       "testdata",
+      "testdesc",
       "testfunc",
       "testonly",
       "testprocessor",

cmd/mdatagen/internal/loader_test.go

@@ -47,6 +47,8 @@ func TestLoadMetadata(t *testing.T) {
 				GithubProject:        "open-telemetry/opentelemetry-collector",
 				GeneratedPackageName: "metadata",
 				Type:                 "sample",
+				DisplayName:          "Sample Receiver",
+				Description:          "This receiver is used for testing purposes to check the output of mdatagen.",
 				SemConvVersion:       "1.38.0",
 				PackageName:          "go.opentelemetry.io/collector/cmd/mdatagen/internal/samplereceiver",
 				Status: &Status{
@@ -553,6 +555,61 @@ func TestLoadMetadata(t *testing.T) {
 			name:    "testdata/~~this file doesn't exist~~.yaml",
 			wantErr: "unable to read the file file:testdata/~~this file doesn't exist~~.yaml",
 		},
+		{
+			name: "testdata/display_name.yaml",
+			want: Metadata{
+				Type:                 "test",
+				DisplayName:          "Test Receiver",
+				GeneratedPackageName: "metadata",
+				ScopeName:            "go.opentelemetry.io/collector/cmd/mdatagen/internal/testdata",
+				PackageName:          "go.opentelemetry.io/collector/cmd/mdatagen/internal/testdata",
+				ShortFolderName:      "testdata",
+				Tests:                Tests{Host: "newMdatagenNopHost()"},
+				Status: &Status{
+					Class: "receiver",
+					Stability: map[component.StabilityLevel][]string{
+						component.StabilityLevelBeta: {"logs"},
+					},
+				},
+			},
+		},
+		{
+			name: "testdata/no_display_name.yaml",
+			want: Metadata{
+				Type:                 "nodisplayname",
+				DisplayName:          "",
+				GeneratedPackageName: "metadata",
+				ScopeName:            "go.opentelemetry.io/collector/cmd/mdatagen/internal/testdata",
+				PackageName:          "go.opentelemetry.io/collector/cmd/mdatagen/internal/testdata",
+				ShortFolderName:      "testdata",
+				Tests:                Tests{Host: "newMdatagenNopHost()"},
+				Status: &Status{
+					Class: "receiver",
+					Stability: map[component.StabilityLevel][]string{
+						component.StabilityLevelBeta: {"logs"},
+					},
+				},
+			},
+		},
+		{
+			name: "testdata/with_description.yaml",
+			want: Metadata{
+				Type:                 "testdesc",
+				DisplayName:          "Test Component",
+				Description:          "This is a test component with a description.",
+				GeneratedPackageName: "metadata",
+				ScopeName:            "go.opentelemetry.io/collector/cmd/mdatagen/internal/testdata",
+				PackageName:          "go.opentelemetry.io/collector/cmd/mdatagen/internal/testdata",
+				ShortFolderName:      "testdata",
+				Tests:                Tests{Host: "newMdatagenNopHost()"},
+				Status: &Status{
+					Class: "receiver",
+					Stability: map[component.StabilityLevel][]string{
+						component.StabilityLevelBeta: {"logs"},
+					},
+				},
+			},
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {

cmd/mdatagen/internal/metadata.go

@@ -18,6 +18,10 @@ import (
 type Metadata struct {
 	// Type of the component.
 	Type string `mapstructure:"type"`
+	// DisplayName is a human-readable display name for the component.
+	DisplayName string `mapstructure:"display_name"`
+	// Description is a brief description of the component.
+	Description string `mapstructure:"description"`
 	// Type of the parent component (applicable to subcomponents).
 	Parent string `mapstructure:"parent"`
 	// Status information for the component.

cmd/mdatagen/internal/sampleconnector/metadata.yaml

@@ -1,6 +1,8 @@
 # Sample metadata file with all available configurations for a connector.
 
 type: sample
+display_name: Sample Connector
+description: This connector is used for testing purposes to check the output of mdatagen.
 github_project: open-telemetry/opentelemetry-collector
 
 sem_conv_version: 1.9.0

cmd/mdatagen/internal/samplefactoryreceiver/README.md

@@ -1,6 +1,8 @@
-# Sample Receiver
-This receiver is used for testing purposes to check the output of mdatagen.
 <!-- status autogenerated section -->
+# Sample Factory Receiver
+
+This receiver is used for testing purposes to check the output of mdatagen.
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [deprecated]: profiles   |

cmd/mdatagen/internal/samplefactoryreceiver/metadata.yaml

@@ -1,6 +1,8 @@
 # Sample metadata file with all available configurations for a receiver.
 
 type: sample
+display_name: Sample Factory Receiver
+description: This receiver is used for testing purposes to check the output of mdatagen.
 scope_name: go.opentelemetry.io/collector/internal/receiver/samplefactoryreceiver
 github_project: open-telemetry/opentelemetry-collector
 

cmd/mdatagen/internal/sampleprocessor/README.md

@@ -1,6 +1,8 @@
+<!-- status autogenerated section -->
 # Sample Processor
+
 This processor is used for testing purposes to check the output of mdatagen.
-<!-- status autogenerated section -->
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [development]: logs   |

cmd/mdatagen/internal/sampleprocessor/metadata.yaml

@@ -1,6 +1,8 @@
-# Sample metadata file with all available configurations for a receiver.
+# Sample metadata file with all available configurations for a processor.
 
 type: sample
+display_name: Sample Processor
+description: This processor is used for testing purposes to check the output of mdatagen.
 scope_name: go.opentelemetry.io/collector/internal/receiver/samplereceiver
 github_project: open-telemetry/opentelemetry-collector
 

cmd/mdatagen/internal/samplereceiver/README.md

@@ -1,6 +1,8 @@
+<!-- status autogenerated section -->
 # Sample Receiver
+
 This receiver is used for testing purposes to check the output of mdatagen.
-<!-- status autogenerated section -->
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [deprecated]: profiles   |