Skip to content

Commit

Permalink
docs: add log filters to the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
oknozor committed Oct 6, 2020
1 parent a1906c3 commit dff77b3
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,9 +206,21 @@ of choice.
commit type etc.



[![asciicast](https://asciinema.org/a/ssH4yRSlc28Rb9dHEDN7TowGe.svg)](https://asciinema.org/a/ssH4yRSlc28Rb9dHEDN7TowGe)

You can also filter the log content with the following flags (`cog log --help`) :

- `-B` : display breaking changes only
- `-t` : filter on commit type
- `-a` : filter on commit author
- `-s` : filter on commit scope
- `-e` : ignore errors

Those flag can be combined to achieve complex search in your commit history :

```shell script
cog log --author "Paul Delafosse" "Mike Lubinets" --type feat --scope cli --no-error
```

### Generate changelogs

Expand Down

0 comments on commit dff77b3

Please sign in to comment.