zeeshan/git-semver

此包的最新版本(v1.0.0)没有提供许可证信息。

v1.0.0 2016-09-23 14:58 UTC

This package is not auto-updated.

Last update: 2024-09-18 19:56:50 UTC


README

Build Status Latest Version Software License

一个命令行工具,用于为您的 git 仓库生成符合 语义化版本控制 的标签。

安装

  • 这里下载文件
  • 分配所需权限 sudo chmod -R 755 git-semver
  • 运行 sudo mv git-semver /usr/local/bin/git-semver

用法

以下是命令的签名

$ git semver <patch|minor|major> [options]

其中 patchminormajor 指定您将要发布的版本类型。

  • patch 在进行向后兼容的错误修复时使用此选项
  • minor 以向后兼容的方式添加功能时使用此选项
  • major 在进行不兼容的 API 变更时使用此选项

选项

除了发布类型,即 patchmajorminor 之外,您还可以添加以下选项来修改命令的行为

  • --fetch 在应用版本之前获取远程标签(推荐)
  • --prefix 预加前缀,例如 --prefix=v 预加 v,即类似 v1.0.1 的标签
  • --postfix 添加到标签末尾,例如 --postfix="-live"-live 添加到生成类似 1.2.3-live 的标签

示例

以下是一些使用示例

标签示例

  • 以下命令创建一个补丁版本,即增加标签的最后部分 1,例如,如果最后一个标签是 x.y.0,则它将生成 x.y.1
$ git semver patch
  • 以下命令创建一个次要版本,即标签的中间部分将增加,例如,如果最后一个标签是 x.2.z,则它将变成 x.3.z
$ git semver minor
  • 以下命令将创建一个主要版本,即标签的第一部分将增加,例如,如果最后一个标签是 0.y.z,则它将变成 1.y.z
$ git semver major

获取远程标签

如果您想在创建标签之前获取远程标签,则使用 --fetch 选项。例如

$ git semver patch --fetch

上述命令将确保在创建新标签之前获取远程标签。顺便说一句,建议添加此标志,例如,如果您在团队中工作,那么您可能没有一些本地标签,不获取远程标签创建标签可能会导致重复的标签。

前缀和后缀的使用

  1. 前缀 如果您想在创建发布时添加一些关键字作为前缀,例如 v,则可以使用 --prefix 选项。例如
$ git semver patch --prefix=v

上述命令将生成带有前缀 v 的标签,例如 v1.0.0v1.3.2

  1. 后缀 如果您想将某些内容追加到创建的标签末尾,则可以使用 --postfix 选项。例如,如果您想将 -dev 追加到标签,可以这样做
$ git semver patch --postfix=-dev

这将导致类似于 3.5.1-dev 的内容,具体取决于最后一个标签

语义化版本控制的实际例子

以下是一些语义化版本控制的有用示例

v0.0.0 // New project
v0.1.0 // Add some functionality
v0.2.0 // Add other new functionality
v0.2.1 // Fix bug
v0.3.0 // Add some functionality
v0.3.1 // Fix bug
v0.3.2 // Fix bug
v0.3.3 // Fix bug
v0.3.4 // Fix bug
v0.4.0 // Add some functionality
v0.4.1 // Fix bug
v0.4.2 // Fix bug
v1.0.0 // Code is being used in production
v1.1.0 // Add some functionality
v1.2.0 // Add other new functionality
v1.2.1 // Fix bug
v2.0.0 // Implement changes that causes backwards incompatible

贡献

请随意分支、改进、创建问题并传播消息。

许可证

MIT © Zeeshan Ahmed