@brillout/release-me
发布您的 npm 软件包 .
用于:
[尖叫声] 别用这个:它只是给维克的团队和朋友用的. 这么说吧,你可以随意把这个项目叉开.
特征
- 生成
CHANGELOG.md。 。 。 . - 莫诺雷波支持.
- 生成 Git 释放标记 .
- 释前供养. (例如
0.4.177-commit-ff3d6cd. ) (中文(简体) ) - 发布前要求确认,并显示更改的预览
package.json财务报告和审定财务报表CHANGELOG.md,允许您在发布前重复检查.
开始吧
安装
运行 $ pnpm -D @brillout/release-me 并确保您有以下内容:
// package.json
{
"name": "my-package",
"version": "0.1.2",
"scripts": {
"build": "echo 'Some build step (release-me runs the build script before releasing)'"
},
"devDependencies": {
"@brillout/release-me": "^0.4.0"
}
}
就是这样,你可以使用 pnpm exec release-me patch 以发布新的补丁版本.
我们建议增加以下文字:
// package.json
{
"name": "my-package",
"version": "0.1.2",
"scripts": {
"build": "echo 'Some build step (release-me runs the build script before releasing)'"
+ "release": "release-me patch",
+ "release:minor": "release-me minor",
+ "release:major": "release-me major",
+ "release:commit": "release-me commit"
},
"devDependencies": {
"@brillout/release-me": "^0.4.0"
}
}
这是向任何发现你项目的人 传达新版本的方便方式.
安装示例 : 8ff59fe。 。 。 .
A 类 CHANGELOG.md 文件将自动生成和更新,参见下一节.
常规武器委员会
当然 CHANGELOG.md 世代确保跟随 常规武器委员会。 。 。 .
换句话说:
fix:qqbug 修正或一些抛光(例如改进后的错误消息).feat:qq新功能,即新功能.
用于突破更改的附加 BREAKING CHANGE: 执行信息:
fix: make someFunction() take an argument object
BREAKING CHANGE: Replace `someFunction(someArg)` with `someFunction({ someArg })`.
[注] 为了尊重 铸造 公约,不要
pnpm exec release-me patch不过pnpm exec release-me major相反(或pnpm exec release-me minor如果你的软件包的版本是0.y.z) (中文(简体) ).
使用量
发布新的补丁/小于/主要版本 :
pnpm exec release-me patch
pnpm exec release-me minor
pnpm exec release-me major
[注] 我们建议界定
package.json#scripts(见上文)和使用$ pnpm run改为$ pnpm exec。 。 。 .
发布特定版本 :
pnpm exec release-me v0.1.2
您也可发布预发文件,例如 0.4.177-commit-ff3d6cd数字 :
pnpm exec release-me commit
单曲
当从单体中释放一个包时,在单体中添加以下承诺: CHANGELOG.md 软件包:
- 如果犯罪具有范围(例如:.
fix(some-package): some commit),只有在瞄准镜与包件相匹配时才将其包括在内package.json#name。 。 。 . - 如果犯罪没有范围(例如:.
fix: some commit),它只有在修改了包根目录中的文件(即包的目录)时才被包含在内package.json(见a/cn.9/wg.iii/wp.96,第2段).
[注] 默认,
CHANGELOG.md生活在软件包的目录中( e)$packageRootDir/CHANGELOG.md),除非存储器只有一个软件包和CHANGELOG.md已经存在于$monorepoRootDir/CHANGELOG.md。 。 。 .