From 9f6a92c9a57f7343a7ad251198b74c17e7d44851 Mon Sep 17 00:00:00 2001 From: "open-sauced[bot]" <63161813+open-sauced[bot]@users.noreply.github.com> Date: Tue, 10 Sep 2024 20:46:36 +0000 Subject: [PATCH] chore: automated docs generation for release Co-authored-by: Zeu Capua --- docs/pizza_generate.md | 1 + docs/pizza_generate_config.md | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+) create mode 100644 docs/pizza_generate_config.md diff --git a/docs/pizza_generate.md b/docs/pizza_generate.md index 5cb89e4..61b0e8e 100644 --- a/docs/pizza_generate.md +++ b/docs/pizza_generate.md @@ -29,4 +29,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 diff --git a/docs/pizza_generate_config.md b/docs/pizza_generate_config.md new file mode 100644 index 0000000..0366cad --- /dev/null +++ b/docs/pizza_generate_config.md @@ -0,0 +1,34 @@ +## pizza generate config + +Generates a ".sauced.yaml" config based on the current repository + +### Synopsis + +Generates a ".sauced.yaml" configuration file. The attribution of emails to given entities +is based on the repository this command is ran in. + +``` +pizza generate config path/to/repo [flags] +``` + +### Options + +``` + -h, --help help for config + -i, --interactive Whether to be interactive + -o, --output-path .sauced.yaml Directory to create the .sauced.yaml file. (default "./") +``` + +### Options inherited from parent commands + +``` + -c, --config string The codeowners 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 +``` + +### SEE ALSO + +* [pizza generate](pizza_generate.md) - Generates documentation and insights from your codebase +