psanetra/git-semver

git-semver

git-semver是一个命令行工具，用于基于Git仓库的历史和标签计算语义化版本。它要求Git历史中的提交消息符合Conventional Commits规范。

拉取Docker镜像

bash
$ docker pull psanetra/git-semver

命令

latest

latest命令通过比较所有Git标签，打印当前仓库的最新语义化版本。标签名称可带有"v"前缀，但此命令输出的版本始终不带该前缀。

示例

打印最新语义化版本（忽略预发布版本）。

bash
$ git-semver latest
1.2.3

打印最新语义化版本（包含预发布版本）。

bash
$ git-semver latest --include-pre-releases
1.2.3-beta

next

next命令用于基于当前分支的历史计算下一个语义化版本。如果最新语义化版本的Git标签在当前分支不可达，或因仓库为浅克隆导致标签提交不可达，该命令将失败。

示例

计算下一个语义化版本（若没有相关变更，将打印最新版本）。

bash
$ git-semver next
1.2.3

计算下一个非稳定语义化版本（仅在尚无稳定版本标签时可用）。

bash
$ git-semver next --stable=false
0.1.2

计算带有计数器的下一个alpha预发布版本。

bash
$ git-semver next --pre-release-tag=alpha --pre-release-counter
1.2.3-alpha.1

log

log命令打印指定版本包含的所有提交日志；若未指定版本，则打印自最新版本以来的所有提交日志。

示例

打印版本1.0.0中添加的提交。

bash
$ git-semver log v1.0.0
commit 478bb9dfdca43216cda6cedcab27faf5c8fd68c0
Author: John Doe <john.doe@example.com>
Date:   Wed Jun 03 20:17:23 2020 +0000

    fix(some_component): Add fix

    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc bibendum vulputate sapien vel mattis.

    Vivamus faucibus leo id libero suscipit, varius tincidunt neque interdum. Mauris rutrum at velit vitae semper.

    Fixes: http://issues.example.com/123
    BREAKING CHANGE: This commit is breaking some API.

commit f716712a4a26491533ba3b6d95e29f9beed85f47
Author: John Doe <john.doe@example.com>
Date:   Wed Jun 03 20:17:23 2020 +0000

    Some non-conventional-commit

commit d44f505f677d52ca23fb9a69de1f5bb6e6085a74
Author: John Doe <john.doe@example.com>
Date:   Wed Jun 03 20:17:22 2020 +0000

    feat: Add feature

仅打印符合规范的提交，格式化为JSON。

bash
$ git-semver log --conventional-commits v1.0.0
[
  {
    "type": "fix",
    "scope": "some_component",
    "breaking_change": true,
    "description": "Add fix",
    "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc bibendum vulputate sapien vel mattis.\n\nVivamus faucibus leo id libero suscipit, varius tincidunt neque interdum. Mauris rutrum at velit vitae semper.",
    "footers": {
      "BREAKING CHANGE": [
        "This commit is breaking some API."
      ],
      "Fixes": [
        "http://issues.example.com/123"
      ]
    }
  },
  {
    "type": "feat",
    "description": "Add feature"
  }
]

打印格式化为Markdown的变更日志。

bash
$ git-semver log --markdown v1.0.0
### BREAKING CHANGES

* **some_component** This commit is breaking some API.

### Features

* Add feature

### Bug Fixes

* **some_component** Add fix
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc bibendum vulputate sapien vel mattis.

Vivamus faucibus leo id libero suscipit, varius tincidunt neque interdum. Mauris rutrum at velit vitae semper.

compare

compare命令用于比较两个语义化版本：

• 若两个版本相等，输出=；
• 若第一个版本低于第二个，输出<；
• 若第一个版本高于第二个，输出>。

示例

比较版本1.2.3和1.2.3-beta

bash
$ git-semver compare 1.2.3 1.2.3-beta
>

比较版本1.2.3-alpha和1.2.3-beta

bash
$ git-semver compare 1.2.3-alpha 1.2.3-beta
<

比较版本1.2.3和1.2.3+build-2018-12-31

bash
$ git-semver compare 1.2.3 1.2.3+build-2018-12-31
=

GitLab Job示例模板

yaml
stages:
  - tag

tag:
  image:
    name: psanetra/git-semver:latest
    entrypoint:
      - "/usr/bin/env"
      - "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
  stage: tag
  variables:
    GIT_DEPTH: 0
    GIT_FETCH_EXTRA_FLAGS: "--prune --prune-tags --tags"
  before_script:
    - apk add --upgrade --no-cache curl
  script: |
    set -ex
    LATEST_VERSION="$(git semver latest)"
    NEXT_VERSION="$(git semver next)"
    if [ "${LATEST_VERSION}" != "${NEXT_VERSION}" ]; then
      NEXT_TAG="v${NEXT_VERSION}"
      git tag "${NEXT_TAG}"
      CHANGELOG="$(git semver log --markdown ${NEXT_TAG})"
      curl -X POST \
        --header "JOB-TOKEN: ${CI_JOB_TOKEN}" \
        --form "tag_name=v${NEXT_VERSION}" \
        --form "ref=${CI_COMMIT_SHA}" \
        --form "description=${CHANGELOG}" \
        "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/releases"
    fi
  only:
    - main
    - master
  except:
    - tags
    - schedules

许可证

MIT