feat: add githubgen tool

.chloggen/add-githubgen.yaml

@@ -0,0 +1,16 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: 'new_component'
+
+# The name of the component, or a single word describing the area of concern, (e.g. crosslink)
+component: githubgen
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Moved githubgen tool here from open-telemetry/opentelemetry-collector-contrib
+
+# One or more tracking issues related to the change
+issues: [639]
+
+# (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:

.github/dependabot.yml

@@ -20,7 +20,7 @@ updates:
       interval: weekly
       day: sunday
   - package-ecosystem: gomod
-    directory: /checkdoc
+    directory: /checkfile
     labels:
       - dependencies
       - go
@@ -29,7 +29,7 @@ updates:
       interval: weekly
       day: sunday
   - package-ecosystem: gomod
-    directory: /checkfile
+    directory: /chloggen
     labels:
       - dependencies
       - go
@@ -38,7 +38,7 @@ updates:
       interval: weekly
       day: sunday
   - package-ecosystem: gomod
-    directory: /chloggen
+    directory: /crosslink
     labels:
       - dependencies
       - go
@@ -47,7 +47,7 @@ updates:
       interval: weekly
       day: sunday
   - package-ecosystem: gomod
-    directory: /crosslink
+    directory: /dbotconf
     labels:
       - dependencies
       - go
@@ -56,7 +56,7 @@ updates:
       interval: weekly
       day: sunday
   - package-ecosystem: gomod
-    directory: /dbotconf
+    directory: /githubgen
     labels:
       - dependencies
       - go

.github/workflows/ci.yml

@@ -21,26 +21,45 @@ jobs:
       with:
         go-version: ${{ env.DEFAULT_GO_VERSION }}
         check-latest: true
+
     - name: Checkout Repo
       uses: actions/checkout@v4
+
     - name: Module cache
       uses: actions/cache@v4
       env:
         cache-name: go-mod-cache
       with:
         path: ~/go/pkg/mod
         key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/go.sum') }}
+
     - name: Tools cache
+      id: cache-tools
       uses: actions/cache@v4
       env:
         cache-name: go-tools-cache
       with:
-        path: ~/.tools
+        path: .tools
         key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('./internal/tools/**') }}
+
+    - name: Install tools
+      if: steps.cache-tools.outputs.cache-hit != 'true'
+      run: make tools
+
+    - name: Add .exe to tools on Windows
+      if: matrix.os == 'windows-latest'
+      shell: bash
+      run: |
+        for file in ./.tools/*; do
+          cp "$file" "${file}.exe"
+        done
+
     - name: Run linters
       run: make multimod-verify dependabot-check license-check lint
+
     - name: Build
       run: make build
+
     - name: Check clean repository
       run: make check-clean-work-tree
 
@@ -55,19 +74,23 @@ jobs:
       with:
         go-version: ${{ env.DEFAULT_GO_VERSION }}
         check-latest: true
+
     - name: Checkout Repo
       uses: actions/checkout@v4
+
     - name: Setup Environment
       run: |
         echo "GOPATH=$(go env GOPATH)" >> $GITHUB_ENV
         echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
+
     - name: Module cache
       uses: actions/cache@v4
       env:
         cache-name: go-mod-cache
       with:
         path: ~/go/pkg/mod
         key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/go.sum') }}
+
     - name: Run tests with race detector
       run: make test-race
 
@@ -79,33 +102,39 @@ jobs:
       with:
         go-version: ${{ env.DEFAULT_GO_VERSION }}
         check-latest: true
+
     - name: Checkout Repo
       uses: actions/checkout@v4
+
     - name: Setup Environment
       run: |
         echo "GOPATH=$(go env GOPATH)" >> $GITHUB_ENV
         echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
+
     - name: Module cache
       uses: actions/cache@v4
       env:
         cache-name: go-mod-cache
       with:
         path: ~/go/pkg/mod
         key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/go.sum') }}
+
     - name: Run coverage tests
       run: |
         make test-coverage
         mkdir $TEST_RESULTS
         cp coverage.out $TEST_RESULTS
         cp coverage.txt $TEST_RESULTS
         cp coverage.html $TEST_RESULTS
+
     - name: Upload coverage report
       uses: codecov/[email protected]
       with:
         file: ./coverage.txt
         fail_ci_if_error: true
         verbose: true
         token: ${{ secrets.CODECOV_TOKEN }}
+
     - name: Store coverage test output
       uses: actions/upload-artifact@v4
       with:

Makefile

@@ -12,6 +12,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+SHELL_CASE_EXP = case "$$(uname -s)" in CYGWIN*|MINGW*|MSYS*) echo "true";; esac;
+UNIX_SHELL_ON_WINDOWS := $(shell $(SHELL_CASE_EXP))
+
+ifeq ($(UNIX_SHELL_ON_WINDOWS),true)
+	# The "sed" transformation below is needed on Windows, since commands like `go list -f '{{ .Dir }}'`
+	# return Windows paths and such paths are incompatible with other *nix tools, like `find`,
+	# used by the Makefile shell.
+	# The backslash needs to be doubled so its passed correctly to the shell.
+	NORMALIZE_DIRS = sed -e 's/^/\\//' -e 's/://' -e 's/\\\\/\\//g' | sort
+	PATH_SEPARATOR=;
+else
+	NORMALIZE_DIRS = sort
+	PATH_SEPARATOR=:
+endif
+
 TOOLS_MOD_DIR := ./internal/tools
 
 # All source code and documents. Used in spell check.
@@ -20,7 +35,7 @@ ALL_DOCS := $(shell find . -name '*.md' -type f | sort)
 ALL_GO_MOD_DIRS := $(filter-out $(TOOLS_MOD_DIR), $(shell find . -type f -name 'go.mod' -exec dirname {} \; | sort))
 ALL_COVERAGE_MOD_DIRS := $(shell find . -type f -name 'go.mod' -exec dirname {} \; | egrep -v '^$(TOOLS_MOD_DIR)' | sort)
 
-GO = go
+GO ?= go
 TIMEOUT = 60
 
 .DEFAULT_GOAL := precommit
@@ -60,17 +75,23 @@ $(TOOLS)/chloggen: PACKAGE=go.opentelemetry.io/build-tools/chloggen
 GOVULNCHECK = $(TOOLS)/govulncheck
  $(TOOLS)/govulncheck: PACKAGE=golang.org/x/vuln/cmd/govulncheck
 
+MOQ = $(TOOLS)/moq
+ $(TOOLS)/moq: PACKAGE=github.com/matryer/moq
+
 .PHONY: tools
-tools: $(DBOTCONF) $(GOLANGCI_LINT) $(MISSPELL) $(MULTIMOD) $(CROSSLINK) $(CHLOGGEN) $(GOVULNCHECK)
+tools: $(DBOTCONF) $(GOLANGCI_LINT) $(MISSPELL) $(MULTIMOD) $(CROSSLINK) $(CHLOGGEN) $(GOVULNCHECK) $(MOQ)
 
 # Build
 
+UPDATED_PATH := $(shell echo $(TOOLS) | $(NORMALIZE_DIRS))
+NEW_PATH := $(UPDATED_PATH)$(PATH_SEPARATOR)$(PATH)
+
 .PHONY: generate build
 generate:
 	set -e; for dir in $(ALL_GO_MOD_DIRS); do \
 	  echo "$(GO) generate $${dir}/..."; \
 	  (cd "$${dir}" && \
-	    PATH="$(TOOLS):$${PATH}" $(GO) generate ./...); \
+	    PATH="$(UPDATED_PATH)$(PATH_SEPARATOR)$${PATH}" $(GO) generate ./...); \
 	done
 
 build: generate

githubgen/README.md

@@ -0,0 +1,37 @@
+# githubgen
+
+This executable is used to generate `.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
+
+```shell
+$> ./githubgen
+```
+
+The equivalent of:
+
+```shell
+$> 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.