Skip to content

Commit 7463656

Browse files
committed
docs(changelog_cli): update readme
1 parent 202c1f4 commit 7463656

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

changelog_cli/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,22 @@ brew install changelog_cli
3535

3636
## Usage
3737

38+
Get usage information:
39+
40+
```sh
41+
changelog_cli generate --help
42+
```
43+
44+
Generate a changelog:
45+
3846
```sh
3947
changelog_cli generate
4048

41-
# or
49+
# or more elaborate
4250
changelog_cli generate --path ~/Projects/my-app --start 1.0.0 --end 1.1.0 --version 1.1.0 --limit 2000 --printer markdown
51+
52+
# or with custom formatting
53+
changelog_cli generate --path packages/something --start $CM_PREVIOUS_COMMIT --version "Version $BUILD_VERSION ($PROJECT_BUILD_NUMBER)" --printer slack-markdown --group-by date-asc --date-format-locale en_US --date-format yyyy-MM-dd
4354
```
4455

4556
You can get the previous tag using git command and then pass it to `changelog_cli`:

0 commit comments

Comments
 (0)