@4th-motion/release 中文文档教程
@4th-motion/release
使用单个命令更新新版本并更新您的变更日志。
告别手写的变更日志 - 使用此工具，创建 GitHub 版本并自此发布所有变更最后一个版本会自动记录在更新日志文件中。 您可以查看生成的变更日志文件 的样子。
Installation
将此包作为 devDependency 添加到您的项目中：
yarn add --dev @4th-motion/release
Usage
一旦完成后，您可以运行命令： 系统
yarn release
会询问您要发布哪个版本。 如果您输入了一个有效版本，您的变更日志将被调整，一个标签将被创建并推送所有变更。 当您为您的提交使用某些关键字时（例如 fix:、feat:、...），您的提交将在变更日志中相应地排序。
注意：如果您想确保您的团队遵守特定的提交规则，我们建议使用 @4th-motion/ git 钩子。 在那里你可以定义你的规则并确保只推送示意性正确的提交。
Customize to your needs
此脚本将 master 分支作为默认分支。 并且更改日志文件必须位于项目的根文件夹中。 如果要更改这些设置，可以将一些标志传递给脚本。
yarn release --branch release
yarn release --changelog docs/changelog.md
Further documents
License
版权所有 © 2020 4th motion GmbH。 根据 MIT 许可 发布。
@4th-motion/release
Bump a new version and update your changelog with a single command.
Say goodbye to handwritten changelogs - with this tool, a GitHub release is created and all changes since the last version are automatically recorded in the changelog file. You can have a look at how such a generated changelog file looks like.
Installation
Add this package as a devDependency to your project:
yarn add --dev @4th-motion/release
Usage
Once that is done, you can run the command:
yarn release
You will be asked which version you want to release. If you have entered a valid version, your changelog will be adjusted, a tag will be created and all changes will be pushed. When you use certain keywords for your commits (e.g. fix:, feat:, …) your commits will be sorted accordingly in the changelog.
Note: If you want to make sure your team adheres to specific commit rules, we recommend to use @4th-motion/git-hooks. There you can define your rules and make sure that only schematically correct commits are pushed.
Customize to your needs
This script takes the master branch as default. And the changelog file must be in the root folder of your project. If you want to change these settings, you can pass some flags to the script.
yarn release --branch release
yarn release --changelog docs/changelog.md
Further documents
License
Copyright © 2020 by 4th motion GmbH. Released under the MIT License.
