diff --git a/githubgen/README.md b/githubgen/README.md index fa81f646..6218e5e8 100644 --- a/githubgen/README.md +++ b/githubgen/README.md @@ -1,8 +1,10 @@ # githubgen -This executable is used to generate the `.github/CODEOWNERS` and `.github/ALLOWLIST` files. +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 reads status metadata from `metadata.yaml` files located throughout the +repository. It checks that codeowners are known members of the OpenTelemetry organization. @@ -11,21 +13,27 @@ It checks that codeowners are known members of the OpenTelemetry organization. ``` $> make gengithub ``` + The equivalent of: + ``` $> cd cmd/githubgen && $(GOCMD) install . $> GITHUB_TOKEN= githubgen --folder . [--allowlist cmd/githubgen/allowlist.txt] ``` -## Checking codeowners against OpenTelemetry membership via Github API +## 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. +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. +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. +If a codeowner is present in allowlist.txt and also a member of the +OpenTelemetry organization, the script will error out.