From aa7b1a4f8b792c0be444b811ec7eb7188e377864 Mon Sep 17 00:00:00 2001 From: "open-sauced[bot]" <63161813+open-sauced[bot]@users.noreply.github.com> Date: Mon, 7 Oct 2024 20:04:49 +0000 Subject: [PATCH] chore: automated docs generation for release Co-authored-by: Zeu Capua --- docs/pizza.md | 1 + docs/pizza_offboard.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 docs/pizza_offboard.md diff --git a/docs/pizza.md b/docs/pizza.md index dfd6ca4..27789df 100644 --- a/docs/pizza.md +++ b/docs/pizza.md @@ -26,5 +26,6 @@ pizza [flags] * [pizza generate](pizza_generate.md) - Generates documentation and insights from your codebase * [pizza insights](pizza_insights.md) - Gather insights about git contributors, repositories, users and pull requests * [pizza login](pizza_login.md) - Log into the CLI via GitHub +* [pizza offboard](pizza_offboard.md) - CAUTION: Experimental Command. Removes users from the ".sauced.yaml" config and "CODEOWNERS" files. * [pizza version](pizza_version.md) - Displays the build version of the CLI diff --git a/docs/pizza_offboard.md b/docs/pizza_offboard.md new file mode 100644 index 0000000..82155b2 --- /dev/null +++ b/docs/pizza_offboard.md @@ -0,0 +1,33 @@ +## pizza offboard + +CAUTION: Experimental Command. Removes users from the ".sauced.yaml" config and "CODEOWNERS" files. + +### Synopsis + +CAUTION: Experimental Command. Removes users from the \".sauced.yaml\" config and \"CODEOWNERS\" files. +Requires the users' name OR email. + +``` +pizza offboard [flags] +``` + +### Options + +``` + -h, --help help for offboard + -p, --path string the path to the repository (required) +``` + +### 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](pizza.md) - OpenSauced CLI +