Revert "remove githubgen tool"

This reverts commit 8032a3f.

Author: mowies

cmd/githubgen/Makefile

@@ -0,0 +1 @@
+include ../../Makefile.Common

cmd/githubgen/README.md

@@ -0,0 +1,35 @@
+⚠️ This executable has moved to [opentelemetry-go-build-tools](https://github.com/open-telemetry/opentelemetry-go-build-tools/tree/main/githubgen).
+
+This code is deprecated and will be removed soon. See https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/37294.
+
+# githubgen
+
+This executable is used to generate the `.github/CODEOWNERS` and `.github/ALLOWLIST` files.
+
+It reads status metadata from `metadata.yaml` files located throughout the repository.
+
+It checks that codeowners are known members of the OpenTelemetry organization.
+
+## Usage
+
+```
+$> make gengithub
+```
+The equivalent of:
+```
+$> cd cmd/githubgen && $(GOCMD) install .
+$> GITHUB_TOKEN=<mypattoken> githubgen --folder . [--allowlist cmd/githubgen/allowlist.txt] 
+```
+
+## Checking codeowners against OpenTelemetry membership via Github API
+
+To authenticate, set the environment variable `GITHUB_TOKEN` to a PAT token.  If a PAT is not available you can use the `--skipgithub` flag to avoid checking for membership in the GitHub organization.
+
+For each codeowner, the script will check if the user is registered as a member of the OpenTelemetry organization.
+
+If any codeowner is missing, it will stop and print names of missing codeowners.
+
+These can be added to allowlist.txt as a workaround.
+
+If a codeowner is present in allowlist.txt and also a member of the OpenTelemetry organization, the script will error out.
+

cmd/githubgen/codeowners.go

@@ -0,0 +1,237 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+package main
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"path/filepath"
+	"sort"
+	"strings"
+
+	"github.com/google/go-github/v68/github"
+)
+
+const allowlistHeader = `# Code generated by githubgen. DO NOT EDIT.
+#####################################################
+#
+# List of components in OpenTelemetry Collector Contrib
+# waiting on owners to be assigned
+#
+#####################################################
+#
+# Learn about membership in OpenTelemetry community:
+#  https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md
+#
+#
+# Learn about CODEOWNERS file format:
+#  https://help.github.com/en/articles/about-code-owners
+#
+
+## 
+# NOTE: New components MUST have one or more codeowners. Add codeowners to the component metadata.yaml and run make gengithub
+##
+
+## COMMON & SHARED components
+internal/common
+
+`
+
+const unmaintainedHeader = `
+
+## UNMAINTAINED components
+
+`
+
+const codeownersHeader = `# Code generated by githubgen. DO NOT EDIT.
+#####################################################
+#
+# List of codeowners for OpenTelemetry Collector Contrib
+#
+#####################################################
+#
+# Learn about membership in OpenTelemetry community:
+# https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md
+#
+#
+# Learn about CODEOWNERS file format:
+# https://help.github.com/en/articles/about-code-owners
+#
+
+* @open-telemetry/collector-contrib-approvers
+`
+
+const distributionCodeownersHeader = `
+#####################################################
+#
+# List of distribution maintainers for OpenTelemetry Collector Contrib
+#
+#####################################################
+`
+
+type codeownersGenerator struct {
+	skipGithub bool
+}
+
+func (cg codeownersGenerator) generate(data *githubData) error {
+	allowlistData, err := os.ReadFile(data.allowlistFilePath)
+	if err != nil {
+		return err
+	}
+	allowlistLines := strings.Split(string(allowlistData), "\n")
+
+	allowlist := make(map[string]struct{}, len(allowlistLines))
+	unusedAllowlist := make(map[string]struct{}, len(allowlistLines))
+	for _, line := range allowlistLines {
+		if line == "" {
+			continue
+		}
+		allowlist[line] = struct{}{}
+		unusedAllowlist[line] = struct{}{}
+	}
+	var missingCodeowners []string
+	var duplicateCodeowners []string
+	members, err := cg.getGithubMembers()
+	if err != nil {
+		return err
+	}
+	for _, codeowner := range data.codeowners {
+		_, present := members[codeowner]
+
+		if !present {
+			_, allowed := allowlist[codeowner]
+			delete(unusedAllowlist, codeowner)
+			allowed = allowed || strings.HasPrefix(codeowner, "open-telemetry/")
+			if !allowed {
+				missingCodeowners = append(missingCodeowners, codeowner)
+			}
+		} else if _, ok := allowlist[codeowner]; ok {
+			duplicateCodeowners = append(duplicateCodeowners, codeowner)
+		}
+	}
+	if len(missingCodeowners) > 0 && !cg.skipGithub {
+		sort.Strings(missingCodeowners)
+		return fmt.Errorf("codeowners are not members: %s", strings.Join(missingCodeowners, ", "))
+	}
+	if len(duplicateCodeowners) > 0 {
+		sort.Strings(duplicateCodeowners)
+		return fmt.Errorf("codeowners members duplicate in allowlist: %s", strings.Join(duplicateCodeowners, ", "))
+	}
+	if len(unusedAllowlist) > 0 {
+		var unused []string
+		for k := range unusedAllowlist {
+			unused = append(unused, k)
+		}
+		sort.Strings(unused)
+		return fmt.Errorf("unused members in allowlist: %s", strings.Join(unused, ", "))
+	}
+
+	codeowners := codeownersHeader
+	deprecatedList := "## DEPRECATED components\n"
+	unmaintainedList := "\n## UNMAINTAINED components\n"
+
+	unmaintainedCodeowners := unmaintainedHeader
+	currentFirstSegment := ""
+LOOP:
+	for _, key := range data.folders {
+		m := data.components[key]
+		for stability := range m.Status.Stability {
+			if stability == unmaintainedStatus {
+				unmaintainedList += key + "/\n"
+				unmaintainedCodeowners += fmt.Sprintf("%s/%s @open-telemetry/collector-contrib-approvers\n", key, strings.Repeat(" ", data.maxLength-len(key)))
+				continue LOOP
+			}
+			if stability == "deprecated" && (m.Status.Codeowners == nil || len(m.Status.Codeowners.Active) == 0) {
+				deprecatedList += key + "/\n"
+			}
+		}
+
+		if m.Status.Codeowners != nil {
+			parts := strings.Split(key, string(os.PathSeparator))
+			firstSegment := parts[0]
+			if firstSegment != currentFirstSegment {
+				currentFirstSegment = firstSegment
+				codeowners += "\n"
+			}
+			owners := ""
+			for _, owner := range m.Status.Codeowners.Active {
+				owners += " "
+				owners += "@" + owner
+			}
+			codeowners += fmt.Sprintf("%s/%s @open-telemetry/collector-contrib-approvers%s\n", key, strings.Repeat(" ", data.maxLength-len(key)), owners)
+		}
+	}
+
+	codeowners += distributionCodeownersHeader
+	longestName := 0
+	for _, dist := range data.distributions {
+		if longestName < len(dist.Name) {
+			longestName = len(dist.Name)
+		}
+	}
+
+	for _, dist := range data.distributions {
+		var maintainers []string
+		for _, m := range dist.Maintainers {
+			maintainers = append(maintainers, fmt.Sprintf("@%s", m))
+		}
+
+		distribution := fmt.Sprintf("\nreports/distributions/%s.yaml%s @open-telemetry/collector-contrib-approvers", dist.Name, strings.Repeat(" ", longestName-len(dist.Name)))
+		if len(maintainers) > 0 {
+			distribution += fmt.Sprintf(" %s", strings.Join(maintainers, " "))
+		}
+
+		codeowners += distribution
+	}
+
+	err = os.WriteFile(filepath.Join(".github", "CODEOWNERS"), []byte(codeowners+unmaintainedCodeowners), 0o600)
+	if err != nil {
+		return err
+	}
+	err = os.WriteFile(filepath.Join(".github", "ALLOWLIST"), []byte(allowlistHeader+deprecatedList+unmaintainedList), 0o600)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+func (cg codeownersGenerator) getGithubMembers() (map[string]struct{}, error) {
+	if cg.skipGithub {
+		// don't try to get organization members if no token is expected
+		return map[string]struct{}{}, nil
+	}
+	githubToken := os.Getenv("GITHUB_TOKEN")
+	if githubToken == "" {
+		return nil, fmt.Errorf("Set the environment variable `GITHUB_TOKEN` to a PAT token to authenticate")
+	}
+	client := github.NewClient(nil).WithAuthToken(githubToken)
+	var allUsers []*github.User
+	pageIndex := 0
+	for {
+		users, resp, err := client.Organizations.ListMembers(context.Background(), "open-telemetry",
+			&github.ListMembersOptions{
+				PublicOnly: false,
+				ListOptions: github.ListOptions{
+					PerPage: 50,
+					Page:    pageIndex,
+				},
+			},
+		)
+		if err != nil {
+			return nil, err
+		}
+		defer resp.Body.Close()
+		if len(users) == 0 {
+			break
+		}
+		allUsers = append(allUsers, users...)
+		pageIndex++
+	}
+
+	usernames := make(map[string]struct{}, len(allUsers))
+	for _, u := range allUsers {
+		usernames[*u.Login] = struct{}{}
+	}
+	return usernames, nil
+}

cmd/githubgen/distributions.go

@@ -0,0 +1,62 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package main
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"sort"
+
+	"gopkg.in/yaml.v3"
+)
+
+type distributionsGenerator struct{}
+
+type distOutput struct {
+	Name        string              `yaml:"name"`
+	URL         string              `yaml:"url"`
+	Maintainers []string            `yaml:"maintainers"`
+	Components  map[string][]string `yaml:"components"`
+}
+
+func (cg distributionsGenerator) generate(data *githubData) error {
+	for _, dist := range data.distributions {
+		components := map[string][]string{}
+		for _, c := range data.components {
+			inDistro := false
+			for _, componentDistro := range c.Status.Distributions {
+				if dist.Name == componentDistro {
+					inDistro = true
+					break
+				}
+			}
+			if inDistro {
+				array, ok := components[c.Status.Class]
+				if !ok {
+					array = []string{}
+				}
+				components[c.Status.Class] = append(array, c.Type)
+			}
+		}
+		for _, comps := range components {
+			sort.Strings(comps)
+		}
+		output := distOutput{
+			Name:        dist.Name,
+			URL:         dist.URL,
+			Maintainers: dist.Maintainers,
+			Components:  components,
+		}
+		b, err := yaml.Marshal(output)
+		if err != nil {
+			return nil
+		}
+		err = os.WriteFile(filepath.Join("reports", "distributions", fmt.Sprintf("%s.yaml", dist.Name)), b, 0o600)
+		if err != nil {
+			return nil
+		}
+	}
+	return nil
+}

cmd/githubgen/go.mod

@@ -0,0 +1,23 @@
+// Deprecated: use https://github.com/open-telemetry/opentelemetry-go-build-tools/tree/main/githubgen
+module github.com/open-telemetry/opentelemetry-collector-contrib/cmd/githubgen
+
+go 1.22.0
+
+require (
+	github.com/google/go-github/v68 v68.0.0
+	go.opentelemetry.io/collector/confmap v1.24.1-0.20250121185328-fbefb22cc2b3
+	go.opentelemetry.io/collector/confmap/provider/fileprovider v1.24.1-0.20250121185328-fbefb22cc2b3
+	gopkg.in/yaml.v3 v3.0.1
+)
+
+require (
+	github.com/go-viper/mapstructure/v2 v2.2.1 // indirect
+	github.com/google/go-querystring v1.1.0 // indirect
+	github.com/knadh/koanf/maps v0.1.1 // indirect
+	github.com/knadh/koanf/providers/confmap v0.1.0 // indirect
+	github.com/knadh/koanf/v2 v2.1.2 // indirect
+	github.com/mitchellh/copystructure v1.2.0 // indirect
+	github.com/mitchellh/reflectwalk v1.0.2 // indirect
+	go.uber.org/multierr v1.11.0 // indirect
+	go.uber.org/zap v1.27.0 // indirect
+)