Skip to content

Commit

Permalink
Add usage for package rename options in README (#173)
Browse files Browse the repository at this point in the history
Update the CLI Usage section of the README to mention
`--tag-prefix-before-package-name` and `--version-before-package-rename`
so that they can be linked to.
  • Loading branch information
mcmire authored Oct 25, 2023
1 parent 4574a31 commit 1ed1544
Showing 1 changed file with 48 additions and 8 deletions.
56 changes: 48 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,63 @@ or

### Update

To update the 'Unreleased' section of the changelog:
#### Update the "Unreleased" section of the changelog

`npx @metamask/auto-changelog update`
`yarn run auto-changelog update`

To update the current release section of the changelog:
or

`npm run auto-changelog update`

`npx @metamask/auto-changelog update --rc`
#### Update the current release section of the changelog

`yarn run auto-changelog update --rc`

or

`npm run auto-changelog update --rc`

### Validate

To validate the changelog:
#### Validate the changelog simply

`yarn run auto-changelog validate`

or

`npm run auto-changelog validate`

#### Validate the changelog for a release candidate

`yarn run auto-changelog validate --rc`

or

`npm run auto-changelog validate --rc`

#### Validate the changelog with package-specific Git tags

This option is designed to be used for packages that live in a monorepo.

`npx @metamask/auto-changelog validate`
For instance, if your package is called `@metamask/polling-controller` and thus all Git tags for this package are prefixed with `@metamask/polling-controller@`:

`yarn run auto-changelog validate --tag-prefix "@metamask/polling-controller@"`

or

To validate the changelog in a release candidate environment:
`npm run auto-changelog validate --tag-prefix "@metamask/polling-controller@"`

#### Validate the changelog for a renamed package

This option is designed to be used for packages that live in a monorepo.

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:

`yarn run auto-changelog validate --tag-prefix-before-package-rename "polling-controller@" --version-before-package-name 0.2.3 --tag-prefix "@metamask/polling-controller@"`

or

`npx @metamask/auto-changelog validate --rc`
`npm run auto-changelog validate --tag-prefix-before-package-rename "polling-controller@" --version-before-package-name 0.2.3 --tag-prefix "@metamask/polling-controller@"`

## API Usage

Expand Down

0 comments on commit 1ed1544

Please sign in to comment.