semver-tool 项目使用教程

1. 项目目录结构及介绍

semver-tool/
├── src/
│   └── semver
├── test/
│   ├── test_semver.bats
│   └── ...
├── .github/
│   └── workflows/
│       └── ci.yml
├── DEPENDENCIES
├── LICENSE
├── Makefile
└── README.md

目录结构说明

• src/: 包含项目的核心源代码文件，其中 semver 是主要的可执行脚本。
• test/: 包含项目的测试文件，使用 bats 测试框架进行单元测试。
• .github/workflows/: 包含 GitHub Actions 的工作流配置文件，用于持续集成和自动化测试。
• DEPENDENCIES: 列出项目依赖的工具和版本。
• LICENSE: 项目的开源许可证文件，采用 Apache-2.0 许可证。
• Makefile: 项目的构建和测试脚本。
• README.md: 项目的介绍和使用说明文档。

2. 项目启动文件介绍

启动文件：src/semver

src/semver 是项目的启动文件，它是一个 Bash 脚本，用于处理语义版本的操作。该脚本支持以下功能：

• 版本升级：包括 major、minor、patch、prerel、build 和 release。
• 版本提取：提取版本中的 major、minor、patch、prerel、build 和 release 部分。
• 版本比较：比较两个版本的先后顺序。
• 版本差异：显示两个版本之间的差异。
• 版本验证：验证给定的版本字符串是否符合语义版本规范。

使用示例

# 升级版本
semver bump patch 1.2.3

# 提取版本部分
semver get minor 1.2.3

# 比较版本
semver compare 1.2.3 1.2.4

# 验证版本
semver validate 1.2.3

3. 项目的配置文件介绍

配置文件：Makefile

Makefile 是项目的构建和测试脚本，它定义了项目的构建规则和测试命令。主要功能包括：

• 测试：运行项目的所有测试用例。
• 安装：将 semver 脚本安装到系统路径中。
• 清理：清理项目生成的临时文件。

使用示例

# 运行测试
make test

# 安装脚本
make install

# 清理项目
make clean

配置文件：.github/workflows/ci.yml

.github/workflows/ci.yml 是 GitHub Actions 的工作流配置文件，用于在每次提交代码时自动运行测试。该文件定义了 CI 流程，包括：

• 触发条件：在每次推送或拉取请求时触发。
• 运行环境：使用指定的操作系统（如 Ubuntu）和工具版本。
• 测试步骤：运行 make test 命令来执行测试。

使用示例

name: CI
on: [push, pull_request]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Run tests
      run: make test

通过以上配置，项目可以在每次代码更新时自动进行测试，确保代码的稳定性和可靠性。