diff --git a/docs/pizza.md b/docs/pizza.md index 58ea659..dfd6ca4 100644 --- a/docs/pizza.md +++ b/docs/pizza.md @@ -13,7 +13,7 @@ pizza [flags] ### Options ``` - -c, --config string The codeowners config (default "~/.sauced.yaml") + -c, --config string The codeowners config --disable-telemetry Disable sending telemetry data to OpenSauced -h, --help help for pizza -l, --log-level string The logging level. Options: error, warn, info, debug (default "info") diff --git a/docs/pizza_completion.md b/docs/pizza_completion.md index 1506e1b..c3a9471 100644 --- a/docs/pizza_completion.md +++ b/docs/pizza_completion.md @@ -17,7 +17,7 @@ See each sub-command's help for details on how to use the generated script. ### Options inherited from parent commands ``` - -c, --config string The codeowners config (default "~/.sauced.yaml") + -c, --config string The codeowners config --disable-telemetry Disable sending telemetry data to OpenSauced -l, --log-level string The logging level. Options: error, warn, info, debug (default "info") --tty-disable Disable log stylization. Suitable for CI/CD and automation diff --git a/docs/pizza_completion_bash.md b/docs/pizza_completion_bash.md index 3a32c97..ea8aae4 100644 --- a/docs/pizza_completion_bash.md +++ b/docs/pizza_completion_bash.md @@ -40,7 +40,7 @@ pizza completion bash ### Options inherited from parent commands ``` - -c, --config string The codeowners config (default "~/.sauced.yaml") + -c, --config string The codeowners config --disable-telemetry Disable sending telemetry data to OpenSauced -l, --log-level string The logging level. Options: error, warn, info, debug (default "info") --tty-disable Disable log stylization. Suitable for CI/CD and automation diff --git a/docs/pizza_completion_fish.md b/docs/pizza_completion_fish.md index 734d1e0..a8d278a 100644 --- a/docs/pizza_completion_fish.md +++ b/docs/pizza_completion_fish.md @@ -31,7 +31,7 @@ pizza completion fish [flags] ### Options inherited from parent commands ``` - -c, --config string The codeowners config (default "~/.sauced.yaml") + -c, --config string The codeowners config --disable-telemetry Disable sending telemetry data to OpenSauced -l, --log-level string The logging level. Options: error, warn, info, debug (default "info") --tty-disable Disable log stylization. Suitable for CI/CD and automation diff --git a/docs/pizza_completion_powershell.md b/docs/pizza_completion_powershell.md index 06b2036..4de607a 100644 --- a/docs/pizza_completion_powershell.md +++ b/docs/pizza_completion_powershell.md @@ -28,7 +28,7 @@ pizza completion powershell [flags] ### Options inherited from parent commands ``` - -c, --config string The codeowners config (default "~/.sauced.yaml") + -c, --config string The codeowners config --disable-telemetry Disable sending telemetry data to OpenSauced -l, --log-level string The logging level. Options: error, warn, info, debug (default "info") --tty-disable Disable log stylization. Suitable for CI/CD and automation diff --git a/docs/pizza_completion_zsh.md b/docs/pizza_completion_zsh.md index 5e45162..ccc8522 100644 --- a/docs/pizza_completion_zsh.md +++ b/docs/pizza_completion_zsh.md @@ -42,7 +42,7 @@ pizza completion zsh [flags] ### Options inherited from parent commands ``` - -c, --config string The codeowners config (default "~/.sauced.yaml") + -c, --config string The codeowners config --disable-telemetry Disable sending telemetry data to OpenSauced -l, --log-level string The logging level. Options: error, warn, info, debug (default "info") --tty-disable Disable log stylization. Suitable for CI/CD and automation diff --git a/docs/pizza_generate.md b/docs/pizza_generate.md index 61b0e8e..49c37ca 100644 --- a/docs/pizza_generate.md +++ b/docs/pizza_generate.md @@ -19,7 +19,7 @@ pizza generate [subcommand] [flags] ### Options inherited from parent commands ``` - -c, --config string The codeowners config (default "~/.sauced.yaml") + -c, --config string The codeowners config --disable-telemetry Disable sending telemetry data to OpenSauced -l, --log-level string The logging level. Options: error, warn, info, debug (default "info") --tty-disable Disable log stylization. Suitable for CI/CD and automation @@ -30,4 +30,5 @@ pizza generate [subcommand] [flags] * [pizza](pizza.md) - OpenSauced CLI * [pizza generate codeowners](pizza_generate_codeowners.md) - Generate a CODEOWNERS file for a GitHub repository using a "~/.sauced.yaml" config * [pizza generate config](pizza_generate_config.md) - Generates a ".sauced.yaml" config based on the current repository +* [pizza generate insight](pizza_generate_insight.md) - Generate an OpenSauced Contributor Insight based on GitHub logins in a CODEOWNERS file diff --git a/docs/pizza_generate_codeowners.md b/docs/pizza_generate_codeowners.md index dcbbfd0..fc69c5e 100644 --- a/docs/pizza_generate_codeowners.md +++ b/docs/pizza_generate_codeowners.md @@ -52,7 +52,7 @@ pizza generate codeowners . --config /path/to/.sauced.yaml ### Options inherited from parent commands ``` - -c, --config string The codeowners config (default "~/.sauced.yaml") + -c, --config string The codeowners config --disable-telemetry Disable sending telemetry data to OpenSauced -l, --log-level string The logging level. Options: error, warn, info, debug (default "info") --tty-disable Disable log stylization. Suitable for CI/CD and automation diff --git a/docs/pizza_generate_config.md b/docs/pizza_generate_config.md index 0366cad..d268e36 100644 --- a/docs/pizza_generate_config.md +++ b/docs/pizza_generate_config.md @@ -22,7 +22,7 @@ pizza generate config path/to/repo [flags] ### Options inherited from parent commands ``` - -c, --config string The codeowners config (default "~/.sauced.yaml") + -c, --config string The codeowners config --disable-telemetry Disable sending telemetry data to OpenSauced -l, --log-level string The logging level. Options: error, warn, info, debug (default "info") --tty-disable Disable log stylization. Suitable for CI/CD and automation diff --git a/docs/pizza_generate_insight.md b/docs/pizza_generate_insight.md new file mode 100644 index 0000000..628c1a3 --- /dev/null +++ b/docs/pizza_generate_insight.md @@ -0,0 +1,48 @@ +## pizza generate insight + +Generate an OpenSauced Contributor Insight based on GitHub logins in a CODEOWNERS file + +### Synopsis + +Generate an OpenSauced Contributor Insight based on GitHub logins in a CODEOWNERS file +to get metrics and insights on those users. + +The provided path must be a local git repo with a valid CODEOWNERS file and GitHub "@login" +for each codeowner. + +After logging in, the generated Contributor Insight on OpenSauced will have insights on +active contributors, contributon velocity, and more. + +``` +pizza generate insight path/to/repo/with/CODEOWNERS/file [flags] +``` + +### Examples + +``` + # Use CODEOWNERS file in explicit directory + $ pizza generate insight /path/to/repo + + # Use CODEOWNERS file in local directory + $ pizza generate insight . +``` + +### Options + +``` + -h, --help help for insight +``` + +### Options inherited from parent commands + +``` + -c, --config string The codeowners config + --disable-telemetry Disable sending telemetry data to OpenSauced + -l, --log-level string The logging level. Options: error, warn, info, debug (default "info") + --tty-disable Disable log stylization. Suitable for CI/CD and automation +``` + +### SEE ALSO + +* [pizza generate](pizza_generate.md) - Generates documentation and insights from your codebase + diff --git a/docs/pizza_insights.md b/docs/pizza_insights.md index 7933480..27007db 100644 --- a/docs/pizza_insights.md +++ b/docs/pizza_insights.md @@ -20,7 +20,7 @@ pizza insights [flags] ### Options inherited from parent commands ``` - -c, --config string The codeowners config (default "~/.sauced.yaml") + -c, --config string The codeowners config --disable-telemetry Disable sending telemetry data to OpenSauced -l, --log-level string The logging level. Options: error, warn, info, debug (default "info") --tty-disable Disable log stylization. Suitable for CI/CD and automation diff --git a/docs/pizza_insights_contributors.md b/docs/pizza_insights_contributors.md index 6c9d868..c228baa 100644 --- a/docs/pizza_insights_contributors.md +++ b/docs/pizza_insights_contributors.md @@ -21,7 +21,7 @@ pizza insights contributors url... [flags] ### Options inherited from parent commands ``` - -c, --config string The codeowners config (default "~/.sauced.yaml") + -c, --config string The codeowners config --disable-telemetry Disable sending telemetry data to OpenSauced -l, --log-level string The logging level. Options: error, warn, info, debug (default "info") -o, --output string The formatting for command output. One of: (table, yaml, csv, json) (default "table") diff --git a/docs/pizza_insights_repositories.md b/docs/pizza_insights_repositories.md index 9754648..f7d5036 100644 --- a/docs/pizza_insights_repositories.md +++ b/docs/pizza_insights_repositories.md @@ -21,7 +21,7 @@ pizza insights repositories url... [flags] ### Options inherited from parent commands ``` - -c, --config string The codeowners config (default "~/.sauced.yaml") + -c, --config string The codeowners config --disable-telemetry Disable sending telemetry data to OpenSauced -l, --log-level string The logging level. Options: error, warn, info, debug (default "info") -o, --output string The formatting for command output. One of: (table, yaml, csv, json) (default "table") diff --git a/docs/pizza_insights_user-contributions.md b/docs/pizza_insights_user-contributions.md index 8f07c9d..e64060b 100644 --- a/docs/pizza_insights_user-contributions.md +++ b/docs/pizza_insights_user-contributions.md @@ -23,7 +23,7 @@ pizza insights user-contributions url... [flags] ### Options inherited from parent commands ``` - -c, --config string The codeowners config (default "~/.sauced.yaml") + -c, --config string The codeowners config --disable-telemetry Disable sending telemetry data to OpenSauced -l, --log-level string The logging level. Options: error, warn, info, debug (default "info") -o, --output string The formatting for command output. One of: (table, yaml, csv, json) (default "table") diff --git a/docs/pizza_login.md b/docs/pizza_login.md index 54ead8f..d1c5965 100644 --- a/docs/pizza_login.md +++ b/docs/pizza_login.md @@ -22,7 +22,7 @@ pizza login [flags] ### Options inherited from parent commands ``` - -c, --config string The codeowners config (default "~/.sauced.yaml") + -c, --config string The codeowners config --disable-telemetry Disable sending telemetry data to OpenSauced -l, --log-level string The logging level. Options: error, warn, info, debug (default "info") --tty-disable Disable log stylization. Suitable for CI/CD and automation diff --git a/docs/pizza_version.md b/docs/pizza_version.md index ce6c725..51efa17 100644 --- a/docs/pizza_version.md +++ b/docs/pizza_version.md @@ -15,7 +15,7 @@ pizza version [flags] ### Options inherited from parent commands ``` - -c, --config string The codeowners config (default "~/.sauced.yaml") + -c, --config string The codeowners config --disable-telemetry Disable sending telemetry data to OpenSauced -l, --log-level string The logging level. Options: error, warn, info, debug (default "info") --tty-disable Disable log stylization. Suitable for CI/CD and automation