[chore] Add test to ensure metadata.yaml is present for all components (

open-telemetry#24643)

**Description:**
This PR uses the checkfile tool introduced in
open-telemetry/opentelemetry-go-build-tools#348
in order to validate the presence of the metadata.yaml file in all
components. It also removes the checkdoc tool in favor of the checkfile
tool, which is now also used to validate the presence of README.md.

**Link to tracking Issue:**
open-telemetry#23376

.github/workflows/build-and-test.yml

@@ -182,6 +182,8 @@ jobs:
  run: make install-tools
  - name: CheckDoc
  run: make checkdoc
+ - name: CheckMetadata
+ run: make checkmetadata
  - name: Porto
  run: |
  make -j2 goporto

Makefile

@@ -345,8 +345,13 @@ build-examples:
 
 # Verify existence of READMEs for components specified as default components in the collector.
 .PHONY: checkdoc
-checkdoc: $(CHECKDOC)
- $(CHECKDOC) --project-path $(CURDIR) --component-rel-path $(COMP_REL_PATH) --module-name $(MOD_NAME)
+checkdoc: $(CHECKFILE)
+ $(CHECKFILE) --project-path $(CURDIR) --component-rel-path $(COMP_REL_PATH) --module-name $(MOD_NAME) --file-name "README.md"
+
+# Verify existence of metadata.yaml for components specified as default components in the collector.
+.PHONY: checkmetadata
+checkmetadata: $(CHECKFILE)
+ $(CHECKFILE) --project-path $(CURDIR) --component-rel-path $(COMP_REL_PATH) --module-name $(MOD_NAME) --file-name "metadata.yaml"
 
 .PHONY: all-checklinks
 all-checklinks:

Makefile.Common

@@ -53,7 +53,7 @@ MULITMOD := $(TOOLS_BIN_DIR)/multimod
 CHLOGGEN := $(TOOLS_BIN_DIR)/chloggen
 GOIMPORTS := $(TOOLS_BIN_DIR)/goimports
 PORTO := $(TOOLS_BIN_DIR)/porto
-CHECKDOC  := $(TOOLS_BIN_DIR)/checkdoc
+CHECKFILE := $(TOOLS_BIN_DIR)/checkfile
 CROSSLINK := $(TOOLS_BIN_DIR)/crosslink
 GOJUNIT := $(TOOLS_BIN_DIR)/go-junit-report
 BUILDER := $(TOOLS_BIN_DIR)/builder

internal/tools/go.mod

@@ -9,7 +9,7 @@ require (
  github.com/google/addlicense v1.1.1
  github.com/jcchavezs/porto v0.4.0
  github.com/jstemmer/go-junit-report v1.0.0
- go.opentelemetry.io/build-tools/checkdoc v0.9.0
+ go.opentelemetry.io/build-tools/checkfile v0.10.0
  go.opentelemetry.io/build-tools/chloggen v0.9.0
  go.opentelemetry.io/build-tools/crosslink v0.9.0
  go.opentelemetry.io/build-tools/issuegenerator v0.9.0
@@ -197,7 +197,7 @@ require (
  github.com/yeya24/promlinter v0.2.0 // indirect
  github.com/ykadowak/zerologlint v0.1.2 // indirect
  gitlab.com/bosi/decorder v0.2.3 // indirect
- go.opentelemetry.io/build-tools v0.9.0 // indirect
+ go.opentelemetry.io/build-tools v0.10.0 // indirect
  go.tmz.dev/musttag v0.7.0 // indirect
  go.uber.org/atomic v1.10.0 // indirect
  go.uber.org/multierr v1.11.0 // indirect

internal/tools/tools.go

@@ -18,7 +18,7 @@ import (
  _ "github.com/google/addlicense"
  _ "github.com/jcchavezs/porto/cmd/porto"
  _ "github.com/jstemmer/go-junit-report"
- _ "go.opentelemetry.io/build-tools/checkdoc"
+ _ "go.opentelemetry.io/build-tools/checkfile"
  _ "go.opentelemetry.io/build-tools/chloggen"
  _ "go.opentelemetry.io/build-tools/crosslink"
  _ "go.opentelemetry.io/build-tools/issuegenerator"