Skip to content

korg: add userinfo command for org and OWNERS lookup #6398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
palnabarun wants to merge 1 commit into
base: main
Choose a base branch
from
Open

korg: add userinfo command for org and OWNERS lookup #6398

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 50 additions & 1 deletion cmd/korg/korg.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,13 @@ limitations under the License.
package main

import (
"context"
"fmt"
"os"
"os/signal"
"path/filepath"
"strings"
"syscall"

"github.com/spf13/cobra"
)
Expand Down Expand Up @@ -58,6 +61,27 @@ Note: Removing from teams is currently unsupported.
`

auditHelpText = "Audit GitHub org members"

userinfoHelpText = `
Gets k8s org membership, GitHub profile, and OWNERS file references for user(s).

Honors GITHUB_TOKEN / GH_TOKEN for authenticated GitHub API access.

A failed per-user lookup does not omit that user from the output: in text mode
it renders an ERROR block, and in JSON mode it appears with only "username"
and "error" populated. Check the exit code to detect any failures.

By default, each OWNERS/OWNERS_ALIASES hit is confirmed against the file's
actual content (via the gh CLI) to exclude emeritus-only entries; this costs
one "gh api" call per hit and requires the gh CLI to be installed and
authenticated. Pass --verify-owners=false to skip this and use hound's raw
search hits as-is.

korg userinfo <github username>
korg userinfo <github username1> <github username2> <github username3> ...
korg userinfo --output json <github username>
korg userinfo --verify-owners=false <github username>
`
)

type Options struct {
Expand Down Expand Up @@ -222,7 +246,32 @@ func main() {
rootCmd.AddCommand(removeCmd)
rootCmd.AddCommand(auditCmd)

if err := rootCmd.Execute(); err != nil {
var (
outputFormat string
verifyOwners bool
)
userInfoCmd := &cobra.Command{
Use: "userinfo",
Short: "Get information about user(s)",
Long: userinfoHelpText,
Args: cobra.MinimumNArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
switch outputFormat {
case "text", "json":
default:
return fmt.Errorf("invalid --output %q (want: text, json)", outputFormat)
}
return runUserinfo(cmd.Context(), o.RepoRoot, args, outputFormat == "json", verifyOwners, cmd.OutOrStdout())
},
}
userInfoCmd.Flags().StringVarP(&outputFormat, "output", "o", "text", "output format: text|json")
userInfoCmd.Flags().BoolVar(&verifyOwners, "verify-owners", true, "confirm each OWNERS/OWNERS_ALIASES hit via the gh CLI and exclude emeritus-only entries; requires gh to be installed and authenticated")
rootCmd.AddCommand(userInfoCmd)

ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
defer stop()

if err := rootCmd.ExecuteContext(ctx); err != nil {
os.Exit(1)
}
}
Loading