Skip to content

Commit

Permalink
Remove POC message and extra indents
Browse files Browse the repository at this point in the history
  • Loading branch information
BekahHW committed Sep 9, 2024
1 parent 624d851 commit f80b9b0
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 27 deletions.
26 changes: 12 additions & 14 deletions cmd/generate/codeowners/codeowners.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,7 @@ type Options struct {
config *config.Spec
}

const codeownersLongDesc string = `WARNING: Proof of concept feature.
Generates a CODEOWNERS file for a given git repository. This uses a ~/.sauced.yaml configuration to attribute emails with given entities.
const codeownersLongDesc string = `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 number of lines touched in that specific file over the specified range of time.`

Expand All @@ -60,21 +58,21 @@ func NewCodeownersCommand() *cobra.Command {
Short: "Generate a CODEOWNERS file for a GitHub repository using a \"~/.sauced.yaml\" config",
Long: codeownersLongDesc,
Example: `
# Generate CODEOWNERS file for the current directory
pizza generate codeowners .
# Generate CODEOWNERS file for the current directory
pizza generate codeowners .
# Generate CODEOWNERS file for a specific repository
pizza generate codeowners /path/to/your/repo
# Generate CODEOWNERS file for a specific repository
pizza generate codeowners /path/to/your/repo
# Generate CODEOWNERS file analyzing the last 180 days
pizza generate codeowners . --range 180
# Generate CODEOWNERS file analyzing the last 180 days
pizza generate codeowners . --range 180
# Generate an OWNERS style file instead of CODEOWNERS
pizza generate codeowners . --owners-style-file
# Generate an OWNERS style file instead of CODEOWNERS
pizza generate codeowners . --owners-style-file
# Specify a custom location for the .sauced.yaml file
pizza generate codeowners . --config /path/to/.sauced.yaml
`,
# Specify a custom location for the .sauced.yaml file
pizza generate codeowners . --config /path/to/.sauced.yaml
`,
Args: func(_ *cobra.Command, args []string) error {
if len(args) != 1 {
return errors.New("you must provide exactly one argument: the path to the repository")
Expand Down
24 changes: 11 additions & 13 deletions docs/pizza_generate_codeowners.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ Generate a CODEOWNERS file for a GitHub repository using a "~/.sauced.yaml" conf

### Synopsis

WARNING: Proof of concept feature.

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 number of lines touched in that specific file over the specified range of time.
Expand All @@ -18,21 +16,21 @@ pizza generate codeowners path/to/repo [flags]

```
# Generate CODEOWNERS file for the current directory
pizza generate codeowners .
# Generate CODEOWNERS file for the current directory
pizza generate codeowners .
# Generate CODEOWNERS file for a specific repository
pizza generate codeowners /path/to/your/repo
# Generate CODEOWNERS file for a specific repository
pizza generate codeowners /path/to/your/repo
# Generate CODEOWNERS file analyzing the last 180 days
pizza generate codeowners . --range 180
# Generate CODEOWNERS file analyzing the last 180 days
pizza generate codeowners . --range 180
# Generate an OWNERS style file instead of CODEOWNERS
pizza generate codeowners . --owners-style-file
# Generate an OWNERS style file instead of CODEOWNERS
pizza generate codeowners . --owners-style-file
# Specify a custom location for the .sauced.yaml file
pizza generate codeowners . --config /path/to/.sauced.yaml
# Specify a custom location for the .sauced.yaml file
pizza generate codeowners . --config /path/to/.sauced.yaml
```

### Options
Expand Down

0 comments on commit f80b9b0

Please sign in to comment.