@metamask/auto-changelog
Advanced tools
Comparing version 3.4.2 to 3.4.3
{ | ||
"name": "@metamask/auto-changelog", | ||
"version": "3.4.2", | ||
"version": "3.4.3", | ||
"description": "Utilities for validating and updating \"Keep a Changelog\" formatted changelogs", | ||
@@ -21,2 +21,3 @@ "publishConfig": { | ||
}, | ||
"license": "(MIT OR Apache-2.0)", | ||
"scripts": { | ||
@@ -23,0 +24,0 @@ "test": "jest", |
@@ -19,20 +19,60 @@ # @metamask/auto-changelog | ||
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 | ||
`npx @metamask/auto-changelog update --rc` | ||
`npm run auto-changelog update` | ||
#### 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 | ||
`npx @metamask/auto-changelog validate` | ||
`yarn run auto-changelog validate` | ||
To validate the changelog in a release candidate environment: | ||
or | ||
`npx @metamask/auto-changelog validate --rc` | ||
`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. | ||
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 | ||
`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 | ||
`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 | ||
@@ -39,0 +79,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Mixed license
License(Experimental) Package contains multiple licenses.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No License Found
License(Experimental) License information could not be found.
Found 1 instance in 1 package
203024
37
178