diff --git a/.prettierignore b/.prettierignore index eeaf7d3..06ead1c 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,11 +1,2 @@ -dist/** - -CHANGELOG.md -.github/** .history/** - -README.md -README.zh-CN.md - -package.json pnpm-lock.yaml diff --git a/CHANGELOG.md b/CHANGELOG.md index 96a8f55..deee64a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,190 +1,124 @@ ## [0.3.2](https://github.com/varletjs/release/compare/v0.3.1...v0.3.2) (2024-12-24) - ### Bug Fixes -* skip confirm registry when skipNpmPublish is true ([#23](https://github.com/varletjs/release/issues/23)) ([ea20a40](https://github.com/varletjs/release/commit/ea20a40c191ba62c96b7e9c1522c3adb0ad42ccf)) - - +- skip confirm registry when skipNpmPublish is true ([#23](https://github.com/varletjs/release/issues/23)) ([ea20a40](https://github.com/varletjs/release/commit/ea20a40c191ba62c96b7e9c1522c3adb0ad42ccf)) ## [0.3.1](https://github.com/varletjs/release/compare/v0.3.0...v0.3.1) (2024-11-02) - - # [0.3.0](https://github.com/varletjs/release/compare/v0.2.11...v0.3.0) (2024-10-26) - ### Features -* support viewing current version ([#12](https://github.com/varletjs/release/issues/12)) ([daf30da](https://github.com/varletjs/release/commit/daf30da9c3004074861915f19d4f28594551a672)) - - +- support viewing current version ([#12](https://github.com/varletjs/release/issues/12)) ([daf30da](https://github.com/varletjs/release/commit/daf30da9c3004074861915f19d4f28594551a672)) ## [0.2.11](https://github.com/varletjs/release/compare/v0.2.10...v0.2.11) (2024-07-16) - ### Features -* update release task function to accept version parameters ([e2b6ead](https://github.com/varletjs/release/commit/e2b6eadc3b2c9de5aa4341ee48ff21264c2c3a26)) - - +- update release task function to accept version parameters ([e2b6ead](https://github.com/varletjs/release/commit/e2b6eadc3b2c9de5aa4341ee48ff21264c2c3a26)) ## [0.2.10](https://github.com/varletjs/release/compare/v0.2.9...v0.2.10) (2024-04-26) - ### Features -* add remote version check to release ([9136d75](https://github.com/varletjs/release/commit/9136d7529d970e1238ec9516879b841f9ba4329d)) - - +- add remote version check to release ([9136d75](https://github.com/varletjs/release/commit/9136d7529d970e1238ec9516879b841f9ba4329d)) ## [0.2.9](https://github.com/varletjs/release/compare/v0.2.8...v0.2.9) (2024-04-21) - ### Features -* ensure commit message path is provided for commit linting ([0eca4a1](https://github.com/varletjs/release/commit/0eca4a1cf0a600c96c805976988e9269233860a9)) - - +- ensure commit message path is provided for commit linting ([0eca4a1](https://github.com/varletjs/release/commit/0eca4a1cf0a600c96c805976988e9269233860a9)) ## [0.2.8](https://github.com/varletjs/release/compare/v0.2.7...v0.2.8) (2024-04-09) - - ## [0.2.7](https://github.com/varletjs/release/compare/v0.2.6...v0.2.7) (2024-04-01) - ### Features -* multiple version confirmation is supported ([#6](https://github.com/varletjs/release/issues/6)) ([ba9ed65](https://github.com/varletjs/release/commit/ba9ed653cae7320dfe2f6c8d9de2f24ca93ef133)) - - +- multiple version confirmation is supported ([#6](https://github.com/varletjs/release/issues/6)) ([ba9ed65](https://github.com/varletjs/release/commit/ba9ed653cae7320dfe2f6c8d9de2f24ca93ef133)) ## [0.2.6](https://github.com/varletjs/release/compare/v0.2.5...v0.2.6) (2024-03-22) - ### Features -* **commitLint:** add merge and wip type ([#5](https://github.com/varletjs/release/issues/5)) ([026a51e](https://github.com/varletjs/release/commit/026a51e62fafe5391d3c9b1320ae33f76ea0d961)) - - +- **commitLint:** add merge and wip type ([#5](https://github.com/varletjs/release/issues/5)) ([026a51e](https://github.com/varletjs/release/commit/026a51e62fafe5391d3c9b1320ae33f76ea0d961)) ## [0.2.5](https://github.com/varletjs/release/compare/v0.2.4...v0.2.5) (2024-02-19) - ### Bug Fixes -* fix tag order ([661cfcc](https://github.com/varletjs/release/commit/661cfccab9aa771d1b196219b525b78ead110478)) - - +- fix tag order ([661cfcc](https://github.com/varletjs/release/commit/661cfccab9aa771d1b196219b525b78ead110478)) ## [0.2.4](https://github.com/varletjs/release/compare/v0.2.3...v0.2.4) (2024-02-19) - ### Features -* support npmTag ([74a0c9a](https://github.com/varletjs/release/commit/74a0c9a235e97b8c1ed167faea54184fe7dfda48)) - - +- support npmTag ([74a0c9a](https://github.com/varletjs/release/commit/74a0c9a235e97b8c1ed167faea54184fe7dfda48)) ## [0.2.3](https://github.com/varletjs/release/compare/v0.2.2...v0.2.3) (2024-01-30) - ### Features -* Check if the npm package has a remote version ([#4](https://github.com/varletjs/release/issues/4)) ([88eab2d](https://github.com/varletjs/release/commit/88eab2d450681e05281a383224a75587520e3a77)) -* support --skip-changelog ([3856b4a](https://github.com/varletjs/release/commit/3856b4a41f5152d9ad3eb0c49673416c1228bbbb)) - - +- Check if the npm package has a remote version ([#4](https://github.com/varletjs/release/issues/4)) ([88eab2d](https://github.com/varletjs/release/commit/88eab2d450681e05281a383224a75587520e3a77)) +- support --skip-changelog ([3856b4a](https://github.com/varletjs/release/commit/3856b4a41f5152d9ad3eb0c49673416c1228bbbb)) ## [0.2.2](https://github.com/varletjs/release/compare/v0.2.1...v0.2.2) (2024-01-25) - ### Bug Fixes -* fix skip git tag command error ([892d771](https://github.com/varletjs/release/commit/892d7712e57383eca8e291c02eed48afae564b9f)) - - +- fix skip git tag command error ([892d771](https://github.com/varletjs/release/commit/892d7712e57383eca8e291c02eed48afae564b9f)) ## [0.2.1](https://github.com/varletjs/release/compare/v0.2.0...v0.2.1) (2024-01-25) - ### Features -* support --skip-git-tag ([6e59690](https://github.com/varletjs/release/commit/6e596905437c4d08a31577690d08a5dbdc0d0007)) - - +- support --skip-git-tag ([6e59690](https://github.com/varletjs/release/commit/6e596905437c4d08a31577690d08a5dbdc0d0007)) # [0.2.0](https://github.com/varletjs/release/compare/v0.1.2...v0.2.0) (2024-01-23) - ### Features -* **release:** implement CI pipeline for automated npm package publishing ([#3](https://github.com/varletjs/release/issues/3)) ([b038c0f](https://github.com/varletjs/release/commit/b038c0fd966b8764beacc8c45d2b96dbbceae62b)) - - +- **release:** implement CI pipeline for automated npm package publishing ([#3](https://github.com/varletjs/release/issues/3)) ([b038c0f](https://github.com/varletjs/release/commit/b038c0fd966b8764beacc8c45d2b96dbbceae62b)) ## [0.1.2](https://github.com/varletjs/release/compare/v0.1.1...v0.1.2) (2023-12-13) - - ## [0.1.1](https://github.com/varletjs/release/compare/v0.1.0...v0.1.1) (2023-12-13) - - # [0.1.0](https://github.com/varletjs/release/compare/v0.0.5...v0.1.0) (2023-12-12) - ### Features -* add custom regex validation and error message display ([f6dc9c3](https://github.com/varletjs/release/commit/f6dc9c3ebb05af25d3aa01ce2a51c776daeac7c9)) - - +- add custom regex validation and error message display ([f6dc9c3](https://github.com/varletjs/release/commit/f6dc9c3ebb05af25d3aa01ce2a51c776daeac7c9)) ## [0.0.5](https://github.com/varletjs/release/compare/v0.0.4...v0.0.5) (2023-12-07) - ### Features -* expose more functions ([7895689](https://github.com/varletjs/release/commit/7895689306a73d5ef3b59e4759e2a603b47a40a7)) - - +- expose more functions ([7895689](https://github.com/varletjs/release/commit/7895689306a73d5ef3b59e4759e2a603b47a40a7)) ## [0.0.4](https://github.com/varletjs/release/compare/v0.0.3...v0.0.4) (2023-12-07) - ### Features -* support lint commit message ([e3200b2](https://github.com/varletjs/release/commit/e3200b2795a93213eab75af68674b1a6ea5327cf)) - - +- support lint commit message ([e3200b2](https://github.com/varletjs/release/commit/e3200b2795a93213eab75af68674b1a6ea5327cf)) ## [0.0.3](https://github.com/varletjs/release/compare/v0.0.2...v0.0.3) (2023-11-17) - ### Bug Fixes -* fix logger ([3728d8d](https://github.com/varletjs/release/commit/3728d8d36809c4eb6ef49017c146f5763ec69237)) -* fix restore error ([1485b38](https://github.com/varletjs/release/commit/1485b3830056e8e27fb3cedc0100e0db08727056)) - - +- fix logger ([3728d8d](https://github.com/varletjs/release/commit/3728d8d36809c4eb6ef49017c146f5763ec69237)) +- fix restore error ([1485b38](https://github.com/varletjs/release/commit/1485b3830056e8e27fb3cedc0100e0db08727056)) ## [0.0.2](https://github.com/varletjs/release/compare/v0.0.1...v0.0.2) (2023-11-15) - ### Features -* remove feature one-time password ([c92c5a0](https://github.com/varletjs/release/commit/c92c5a07cfab6e7a3c4fde7963b4a7a536b23acc)) - - +- remove feature one-time password ([c92c5a0](https://github.com/varletjs/release/commit/c92c5a07cfab6e7a3c4fde7963b4a7a536b23acc)) ## [0.0.1](https://github.com/varletjs/release/compare/15e865524628c2dd7db31de8c3052a6f1e3d2276...v0.0.1) (2023-11-14) - ### Features -* command option add one-time password ([b06fc89](https://github.com/varletjs/release/commit/b06fc893e9c05985fd65bc814e2c33851144c497)) -* init ([15e8655](https://github.com/varletjs/release/commit/15e865524628c2dd7db31de8c3052a6f1e3d2276)) - - - +- command option add one-time password ([b06fc89](https://github.com/varletjs/release/commit/b06fc893e9c05985fd65bc814e2c33851144c497)) +- init ([15e8655](https://github.com/varletjs/release/commit/15e865524628c2dd7db31de8c3052a6f1e3d2276)) diff --git a/README.md b/README.md index 7e61a87..fb3fb98 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ npx vr publish #### Example ```js -import { release, changelog } from '@varlet/release' +import { changelog, release } from '@varlet/release' // Do what you want to do... release() @@ -97,7 +97,7 @@ release() You can pass in a task that will be called before the publish after the package version is changed. ```js -import { release, changelog } from '@varlet/release' +import { changelog, release } from '@varlet/release' async function task() { await doSomething1() diff --git a/README.zh-CN.md b/README.zh-CN.md index b6de2d1..37259ae 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -88,7 +88,7 @@ npx vr publish #### 示例 ```js -import { release, changelog } from '@varlet/release' +import { changelog, release } from '@varlet/release' // Do what you want to do... release() @@ -97,7 +97,7 @@ release() 你可以传入一个 `task`，在包版本更改后，在发布之前会调用 `task`。 ```js -import { release, changelog } from '@varlet/release' +import { changelog, release } from '@varlet/release' async function task() { await doSomething1() diff --git a/package.json b/package.json index 3820178..20caa9e 100644 --- a/package.json +++ b/package.json @@ -49,7 +49,8 @@ "*.{ts,js}": [ "prettier --write", "eslint --fix" - ] + ], + "*.md": "prettier --write" }, "dependencies": { "@inquirer/prompts": "^6.0.1", @@ -83,4 +84,4 @@ "node": ">=16.0.0", "pnpm": ">=9.0" } -} \ No newline at end of file +}