git-semver

为您的 HEAD 提交生成符合语义化版本规范的标签。

CLI

本项目还发布了一个用于命令行的二进制应用程序。

安装

目前，crates.io 是此程序的唯一分发渠道。

cargo install git-semversion

用法

Generate a semantic versioning compliant tag for your HEAD commit

Usage: git-semver [OPTIONS]

Options:
  -m, --main-branch <MAIN_BRANCH>
          The name of your repository's main branch. Useful if you continue to use "master" or "trunk" [default: main]
  -p, --prerelease-id <PRERELEASE_ID>
          Identifier to use for prerelease during non-main branch execution, using branch name slug when omitted
  -r, --prerelease-revision <PRERELEASE_REVISION>
          Revision to use for prerelease during non-main branch execution, using short commit hash when omitted
  -i, --increment <INCREMENT>
          Explicit increment level override for use during main branch execution, forcing to ignore the increment level derived from commit summary [possible values: patch, minor, major]
      --default-increment <DEFAULT_INCREMENT>
          Increment level override for non-merge commits to main branch, ie. commits directly to main branch [default: patch] [possible values: patch, minor, major]
  -e, --match-expression <MATCH_EXPRESSION>
          Regular expression to match the increment level in the commit summary of a commit to the main branch [default: "^Merge .*(patch|minor|major)/[\\w-]+"]
  -h, --help
          Print help
  -V, --version
          Print version

Docker

本项目还发布了一个 Docker 镜像，公开了 CLI 工具。

安装

您可以从 GitHub 的容器注册库中拉取镜像

docker pull ghcr.io/nicholaschiasson/git-semver:latest

或者为了更方便，您可以在 docker compose 文件中引用镜像

---
services:
  git-semver:
    image: ghcr.io/nicholaschiasson/git-semver:latest
    volumes:
      - .:/repo:ro

为了额外方便，您可以创建一个指向 docker compose 命令的别名

echo 'alias git-semver="docker compose --file path/to/docker-compose.yml run --rm git-semver"' >> "${HOME}/.bashrc"
source "${HOME}"/.bashrc

之后，您应该可以简单地运行 git-semver 来调用容器。

用法

Docker 镜像入口是 git-semver CLI 二进制文件本身，这意味着用法与上述指示完全相同。

开发

先决条件

• nix
• nix flakes

如何做

创建开发外壳环境。运行所有其他命令的必要条件。

nix develop

使用 cargo 构建。

just build

使用 cargo 的内置快速静态分析检查代码。

just check

删除构建文件。

just clean

格式化代码。

just format

使用 clippy 进行更好的静态分析。

just lint

运行应用程序。

just run

使用 cargo 的内置测试运行器运行测试。

just test

监视代码更改并重新构建。

just watch

所有 just 命令都可以在 -- 后接受额外的命令行参数。

例如：使用报告版本标志运行应用程序。

just run -- --version

技巧和建议

从开发外壳打开 IDE

为了在 IDE 中链接到 rust 二进制文件，您应该从终端打开开发外壳，然后从该会话打开您的 IDE。这会将开发外壳的环境带到您的 IDE 中。

例如，如果您使用 VSCode。

cd path/to/this/project
nix develop
code .

通过这样做，您可以安装 rust-analyzer VSCode 扩展，并且它可以正常工作，因为它将能够指向正确的 rust 二进制文件和库。您还可以在 VSCode 中访问 nix flake 安装的任何包。

待办事项

• Dockerfile
• 测试
• Github Action