Gitbox

Gitbox 是 get 的精神继承者和重写。

它利用 git CLI 工具实现快速简单的语义化版本控制和常规提交。

注意

除非请求新功能，否则该项目被认为已完成。这意味着除了修复错误和实施新批准的功能外，不会有更多的发展时间。

要请求功能，请创建一个新问题。如果请求的功能被认为与项目相关，它可能会在未来版本中实现。如果您想自己实现该功能，请首先创建一个新问题以请求其批准，然后您可以创建一个 Pull Request。

2.0.0 版本的破坏性变更

• 默认的预发布模式现在是一个单独的数字。
• 将 refresh 子命令从 commit 子命令移动到独立的子命令。
• 从 describe 子命令中删除 docker 子命令。

安装

如果您想安装分发的二进制文件，请运行 cargo install gitbox。

如果您想从源安装，克隆存储库并使用 cargo 路径安装它

git clone <origin-URL> gitbox
cd gitbox
cargo install --path .

Cargo 安装说明

功能

Gitbox 包含多个子命令，执行不同的任务。

帮助信息 gb help（或 gb --help）

Gitbox (gb) is wrapper for git and it enhance some functionalities.

Usage: gb <COMMAND>

Commands:
  changelog  Generate a changelog
  commit     Create a commit with a conventional message
  complete   Print a completion script
  describe   Calculate the next version
  init       Initialize a git repository
  license    Create a license file
  tree       Print a fancy view of the commit tree
  help       Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

帮助

此子命令将打印指定其他子命令的帮助信息

gb help <subcommand>

它等同于 gb <subcommand> --help 或 gb <subcommand> -h。

变更日志

此子命令生成从上次发布（或启用标志的最后一个版本）以来的变更列表。

列表可以使用选项进行格式化（请参阅 gb changelog --help）。

例如，使用Markdown格式化变更日志的命令是 gb changelog --title-format "# %s" --type-format "## %s" --scope-format "### %s" --list-format "%s" --item-format "* %s" --breaking-format "**%s**"。

提交

gb commit 允许轻松创建遵循常规提交标准的提交。

如果没有指定选项，它将询问用户提交类型、作用域、是否为破坏性更改、摘要和提交体。使用选项可以跳过这些问题（通过提供值）。

对于简单的提交（非破坏性且没有正文），建议使用的命令是 gb commit --no-breaking -m ''。

有关选项的完整列表，请运行 gb help commit（或 gb commit --help）。

完成

此子命令打印Gitbox的完成脚本。根据您的shell说明（如果支持）进行安装。

描述

gb describe 从自上次发布以来的提交列表计算新的语义版本。

您可以配置特定更改的触发器（即，如果正确配置了类型和作用域，对核心依赖的更新可以触发补丁更新）。

有关所有配置选项，请参阅 gb help describe。

初始化

此简单子命令使用空提交初始化git仓库，以允许使用其他子命令。

许可

license 子命令从 https://choosealicense.com/ 获取开源许可证列表，并允许用户下载所选许可证文本。

刷新额外内容

此子命令刷新 .git/extra 文件夹的内容，该文件夹包含GitBox工作所需的所有文件。

在克隆远程仓库或拉取远程提交后应运行此命令，因为它们可能为GitBox引入新数据。

由于这可能是一个大型操作，因此它有一个独立的子命令。

树

gb tree 美化打印 git log 的输出。要导航它，可以将输出传递到分页器： gb tree | less。

许可

此软件根据 MIT许可证 分发。