From 9c9db9a188793d363e192d281714a164011d1920 Mon Sep 17 00:00:00 2001 From: "open-sauced[bot]" <63161813+open-sauced[bot]@users.noreply.github.com> Date: Mon, 9 Sep 2024 22:29:32 +0000 Subject: [PATCH] chore: automated docs generation for release Co-authored-by: Nick Taylor --- docs/pizza.md | 2 +- docs/pizza_completion.md | 2 +- docs/pizza_completion_bash.md | 2 +- docs/pizza_completion_fish.md | 2 +- docs/pizza_completion_powershell.md | 2 +- docs/pizza_completion_zsh.md | 2 +- docs/pizza_generate.md | 4 ++-- docs/pizza_generate_codeowners.md | 6 +++--- docs/pizza_insights.md | 2 +- docs/pizza_insights_contributors.md | 2 +- docs/pizza_insights_repositories.md | 2 +- docs/pizza_insights_user-contributions.md | 2 +- docs/pizza_login.md | 2 +- docs/pizza_version.md | 2 +- 14 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/pizza.md b/docs/pizza.md index 49abe05..d265d6f 100644 --- a/docs/pizza.md +++ b/docs/pizza.md @@ -13,7 +13,7 @@ pizza [flags] ### Options ``` - -c, --config string The saucectl config (default "~/.sauced.yaml") + -c, --config string The saucectl config (default ".sauced.yaml") --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 65a7507..eb0665e 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 saucectl config (default "~/.sauced.yaml") + -c, --config string The saucectl config (default ".sauced.yaml") --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 5beed9d..6870d8c 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 saucectl config (default "~/.sauced.yaml") + -c, --config string The saucectl config (default ".sauced.yaml") --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 93bb9de..5aa9ed9 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 saucectl config (default "~/.sauced.yaml") + -c, --config string The saucectl config (default ".sauced.yaml") --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 bec9a87..4514dd6 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 saucectl config (default "~/.sauced.yaml") + -c, --config string The saucectl config (default ".sauced.yaml") --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 22b1734..5910a5b 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 saucectl config (default "~/.sauced.yaml") + -c, --config string The saucectl config (default ".sauced.yaml") --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 edd658d..86eb183 100644 --- a/docs/pizza_generate.md +++ b/docs/pizza_generate.md @@ -21,7 +21,7 @@ pizza generate [subcommand] [flags] ### Options inherited from parent commands ``` - -c, --config string The saucectl config (default "~/.sauced.yaml") + -c, --config string The saucectl config (default ".sauced.yaml") --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,5 +30,5 @@ pizza generate [subcommand] [flags] ### SEE ALSO * [pizza](pizza.md) - OpenSauced CLI -* [pizza generate codeowners](pizza_generate_codeowners.md) - Generates a CODEOWNERS file for a given repository using a "~/.sauced.yaml" config +* [pizza generate codeowners](pizza_generate_codeowners.md) - Generates a CODEOWNERS file for a given repository using a ".sauced.yaml" config diff --git a/docs/pizza_generate_codeowners.md b/docs/pizza_generate_codeowners.md index 0cb8357..3752264 100644 --- a/docs/pizza_generate_codeowners.md +++ b/docs/pizza_generate_codeowners.md @@ -1,12 +1,12 @@ ## pizza generate codeowners -Generates a CODEOWNERS file for a given repository using a "~/.sauced.yaml" config +Generates a CODEOWNERS file for a given repository using a ".sauced.yaml" config ### Synopsis WARNING: Proof of concept feature. -Generates a CODEOWNERS file for a given git repository. This uses a ~/.sauced.yaml +Generates a CODEOWNERS file for a given git repository. This uses a .sauced.yaml configuration to attribute emails with given entities. The generated file specifies up to 3 owners for EVERY file in the git tree based on the @@ -27,7 +27,7 @@ pizza generate codeowners path/to/repo [flags] ### Options inherited from parent commands ``` - -c, --config string The saucectl config (default "~/.sauced.yaml") + -c, --config string The saucectl config (default ".sauced.yaml") --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.md b/docs/pizza_insights.md index c7be12d..f841a91 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 saucectl config (default "~/.sauced.yaml") + -c, --config string The saucectl config (default ".sauced.yaml") --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 ce13c4e..0e12b79 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 saucectl config (default "~/.sauced.yaml") + -c, --config string The saucectl config (default ".sauced.yaml") --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 64070d4..dd297b5 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 saucectl config (default "~/.sauced.yaml") + -c, --config string The saucectl config (default ".sauced.yaml") --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 5ec8b0b..26fd69d 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 saucectl config (default "~/.sauced.yaml") + -c, --config string The saucectl config (default ".sauced.yaml") --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 7ca5124..a3d9a2e 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 saucectl config (default "~/.sauced.yaml") + -c, --config string The saucectl config (default ".sauced.yaml") --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 5848855..db9900e 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 saucectl config (default "~/.sauced.yaml") + -c, --config string The saucectl config (default ".sauced.yaml") --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