GitScribe

• 一个帮助您在项目中维护具有语义版本的变更日志文件的工具。

安装

要求

rust 工具链

• 使用 rustup 安装：https://rustup.rs/

从 cates.io 安装

• cargo安装 gitscribe

为了更好的体验

强制在您的项目中使用约定式提交

• https://github.com/compilerla/conventional-pre-commit
  • 您需要首先安装 pre-commit 工具： https://pre-commit.git-scm.cn/#install

使用方法

gitscribe --help

创建新版本

# depending on the changes you made, you can use the following commands to make a new release version
gitscribe patch | minor | major

幕后，它将执行以下操作

• 如果没有找到配置文件，它将创建一个新文件
• 更新 gitscribe.json 中的版本
• 更新或创建新的变更日志文件
  • 默认文件名为 CHANGELOG.md，位于项目根目录
• 添加并提交更改

如上所示，您必须有一个干净的作业树。

以下是一个成功的示例

使用默认配置，您将在项目根目录生成一个新的 markdown 变更日志，并在您的作业分支上创建一个新的 chore 提交，该提交包含新版本。

此工具将 仅 输出符合约定式提交规范的提交。

设置别名

为了便于使用，您可以在您的 shell 配置文件中设置别名

alias gs="gitscribe"

功能

• 创建新的变更日志文件

• 为不同的输出格式创建多个变更日志文件

• 与其他包管理文件（pyproject.toml，package.json，cargo.toml）同步 gitscribe.json 版本。

• 更多功能即将推出..