Skip to content

README.md

Latest commit

 

History

History
56 lines (39 loc) · 2.01 KB

README.md

File metadata and controls

56 lines (39 loc) · 2.01 KB
Raw

githubgen

This executable is used to generate .github/CODEOWNERS 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

$> ./githubgen

The equivalent of:

$> githubgen --skipgithub --folder . --github-org "open-telemetry" \
  --default-codeowner open-telemetry/opentelemetry-collector-approvers \
  --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.

Additionally, the GitHub organization name needs to be specified using --github-org <your-org>, along with --default-codeowner to be used as the default owner for general files.

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.

Checking codeowners against a team

Optionally, you can require codeowners to be members of a specific org team in addition to being members of the organization by passing --github-team <team-slug>. Team membership is what grants the repository access required for a code owner to be requested as a reviewer, so an org member who is not on the team cannot be auto-requested for reviews.

When --github-team is set, each codeowner (other than allowlisted users and org team handles) must be a member of that team. Codeowners in allowlist.txt are exempt, since they are intentionally not organization members and therefore cannot be team members. If --github-team is not set, only organization membership is checked.