From 69d07b1bb9a204d618b2eb95f62399629e8e3bfb Mon Sep 17 00:00:00 2001 From: "open-sauced[bot]" <63161813+open-sauced[bot]@users.noreply.github.com> Date: Thu, 12 Sep 2024 20:42:27 +0000 Subject: [PATCH] chore: automated docs generation for release Co-authored-by: BekahHW <34313413+BekahHW@users.noreply.github.com> --- docs/pizza_generate_config.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/pizza_generate_config.md b/docs/pizza_generate_config.md index d268e36..bc89a18 100644 --- a/docs/pizza_generate_config.md +++ b/docs/pizza_generate_config.md @@ -4,8 +4,10 @@ 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. +Generates a ".sauced.yaml" configuration file for use with the Pizza CLI's codeowners command. + +This command analyzes the git history of the current repository to create a mapping +of email addresses to GitHub usernames. ``` pizza generate config path/to/repo [flags]