Skip to content

Commit

Permalink
chore: automated docs generation for release
Browse files Browse the repository at this point in the history
Co-authored-by: Zeu Capua <[email protected]>
  • Loading branch information
open-sauced[bot] and zeucapua committed Oct 7, 2024
1 parent 8044105 commit aa7b1a4
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/pizza.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,6 @@ pizza <command> <subcommand> [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

33 changes: 33 additions & 0 deletions docs/pizza_offboard.md
Original file line number Diff line number Diff line change
@@ -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 <username/email> [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

0 comments on commit aa7b1a4

Please sign in to comment.