Skip to content

Commit c8ededa

Browse files
authored
Add changelog update usage for package rename options in README (#184)
1 parent 5ac000a commit c8ededa

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,18 @@ or
3232

3333
`npm run auto-changelog update --rc`
3434

35+
#### Update the changelog for a renamed package
36+
37+
This option is designed to be used for packages that live in a monorepo.
38+
39+
For instance, if your package is called `polling-controller` and was renamed to `@metamask/polling-controller` at version 0.2.3, and thus the Git tags followed suit:
40+
41+
`yarn run auto-changelog update --tag-prefix-before-package-rename "polling-controller@" --version-before-package-name 0.2.3 --tag-prefix "@metamask/polling-controller@"`
42+
43+
or
44+
45+
`npm run auto-changelog update --tag-prefix-before-package-rename "polling-controller@" --version-before-package-name 0.2.3 --tag-prefix "@metamask/polling-controller@"`
46+
3547
### Validate
3648

3749
#### Validate the changelog simply

0 commit comments

Comments
 (0)