MOKA/GitVer
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

更新md文件

Browse Source
This commit is contained in:
Jeff
2026-05-19 16:03:33 +08:00
parent b2b508f520
commit 565575dbc5
1 changed files with 15 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@@ -9,10 +9,10 @@
``` ```
gitver gitver
gitver rewrite [PEType] [-f] gitver rewrite [PEType] [-f]
gitver setver=<pid> [repodir=<path>] [-f] [-test] [-setup=0|1] gitver setver=<pid> [repodir=<path>] [-test] [-setup=0|1]
gitver nuitkabuild=<pid> <mainPy> [repodir=<path>] [-f] [-test] [params="<nuitka参数>"] gitver nuitkabuild=<pid> <mainPy> [repodir=<path>] [-test] [params="<nuitka参数>"]
gitver nuitkapydbuild=<pid> <modulePy> [repodir=<path>] [-f] [-test] [params="<nuitka参数>"] gitver nuitkapydbuild=<pid> <modulePy> [repodir=<path>] [-test] [params="<nuitka参数>"]
gitver -setup=0|1 <pid> [repodir=<path>] [-f] [-test] gitver -setup=0|1 <pid> [repodir=<path>] [-test]
``` ```
**通用参数说明：** **通用参数说明：**
@@ -21,7 +21,6 @@ gitver -setup=0|1 <pid> [repodir=<path>] [-f] [-test]
|---|---| |---|---|
| `pid` | 产品 ID，整数，范围 0-65535，内嵌在命令名中（如 `setver=5`） | | `pid` | 产品 ID，整数，范围 0-65535，内嵌在命令名中（如 `setver=5`） |
| `repodir=<path>` | Git 仓库目录，缺省使用当前运行目录 | | `repodir=<path>` | Git 仓库目录，缺省使用当前运行目录 |
| `-f` | 未找到当前分支 tag 时使用默认 major/minor（1.0）继续 |
| `-test` | 将产品版本号的 major/minor 置为 0（测试版本构建） | | `-test` | 将产品版本号的 major/minor 置为 0（测试版本构建） |
| `params="..."` | 传递给 Nuitka 的额外参数，用双引号括起来 | | `params="..."` | 传递给 Nuitka 的额外参数，用双引号括起来 |
@@ -94,7 +93,7 @@ gitver rewrite -f
从 Git 仓库读取 tag，生成产品版本号与文件版本号，并按源码类型自动回写。 从 Git 仓库读取 tag，生成产品版本号与文件版本号，并按源码类型自动回写。
``` ```
gitver setver=<pid> [repodir=<path>] [-f] [-test] [-setup=0|1] gitver setver=<pid> [repodir=<path>] [-test] [-setup=0|1]
``` ```
**版本号生成规则：** **版本号生成规则：**
@@ -119,7 +118,6 @@ gitver setver=<pid> [repodir=<path>] [-f] [-test] [-setup=0|1]
``` ```
gitver setver=5 gitver setver=5
gitver setver=5 repodir=E:\Code\OTH\gitver gitver setver=5 repodir=E:\Code\OTH\gitver
gitver setver=5 -f
gitver setver=5 -test gitver setver=5 -test
gitver setver=5 -setup=0 gitver setver=5 -setup=0
gitver setver=5 repodir=E:\Code\MyProj -setup=1 gitver setver=5 repodir=E:\Code\MyProj -setup=1
@@ -138,6 +136,7 @@ FileVersion=5.26.0519.3
- **C#**：回写 `AssemblyInfo.cs` 中的 AssemblyVersion、AssemblyFileVersion - **C#**：回写 `AssemblyInfo.cs` 中的 AssemblyVersion、AssemblyFileVersion
- **Python**：仅输出版本号，不执行文件回写，提示改用 Nuitka 命令 - **Python**：仅输出版本号，不执行文件回写，提示改用 Nuitka 命令
- 编码：支持 ANSI/UTF-8（保留 UTF-8 BOM）；UTF-16 文件会报错停止 - 编码：支持 ANSI/UTF-8（保留 UTF-8 BOM）；UTF-16 文件会报错停止
- 当前分支无匹配 tag 时自动使用默认版本 `1.0`
--- ---
@@ -146,7 +145,7 @@ FileVersion=5.26.0519.3
生成版本号并调用 Nuitka 打包 Python 程序（EXE 模式）。 生成版本号并调用 Nuitka 打包 Python 程序（EXE 模式）。
``` ```
gitver nuitkabuild=<pid> <mainPy> [repodir=<path>] [-f] [-test] [params="<nuitka参数>"] gitver nuitkabuild=<pid> <mainPy> [repodir=<path>] [-test] [params="<nuitka参数>"]
``` ```
自动调用： 自动调用：
@@ -159,7 +158,6 @@ python -m nuitka --windows-product-version=<版本> --windows-file-version=<版
``` ```
gitver nuitkabuild=5 main.py gitver nuitkabuild=5 main.py
gitver nuitkabuild=5 main.py -f
gitver nuitkabuild=5 main.py -test gitver nuitkabuild=5 main.py -test
gitver nuitkabuild=5 src\app.py repodir=E:\Code\MyPyProj params="--standalone --output-dir=dist" gitver nuitkabuild=5 src\app.py repodir=E:\Code\MyPyProj params="--standalone --output-dir=dist"
``` ```
@@ -181,7 +179,7 @@ FileVersion=5.26.0519.3
生成版本号并调用 Nuitka 打包 Python 模块（pyd/DLL 模式）。 生成版本号并调用 Nuitka 打包 Python 模块（pyd/DLL 模式）。
``` ```
gitver nuitkapydbuild=<pid> <modulePy> [repodir=<path>] [-f] [-test] [params="<nuitka参数>"] gitver nuitkapydbuild=<pid> <modulePy> [repodir=<path>] [-test] [params="<nuitka参数>"]
``` ```
自动调用： 自动调用：
@@ -194,7 +192,6 @@ python -m nuitka --module --windows-product-version=<版本> --windows-file-vers
``` ```
gitver nuitkapydbuild=5 module.py gitver nuitkapydbuild=5 module.py
gitver nuitkapydbuild=5 module.py -f
gitver nuitkapydbuild=5 module.py -test gitver nuitkapydbuild=5 module.py -test
gitver nuitkapydbuild=5 src\core.py repodir=E:\Code\MyPyProj params="--output-dir=dist" gitver nuitkapydbuild=5 src\core.py repodir=E:\Code\MyPyProj params="--output-dir=dist"
``` ```
@@ -208,7 +205,7 @@ gitver nuitkapydbuild=5 src\core.py repodir=E:\Code\MyPyProj params="--output-di
独立调用安装脚本打包，不依赖 `setver=` 命令。 独立调用安装脚本打包，不依赖 `setver=` 命令。
``` ```
gitver -setup=0|1 <pid> [repodir=<path>] [-f] [-test] gitver -setup=0|1 <pid> [repodir=<path>] [-test]
``` ```
**示例：** **示例：**
@@ -228,21 +225,18 @@ gitver -setup=1 5 repodir=E:\Code\MyProj
| 3 | 参数非法或未知参数 | | 3 | 参数非法或未知参数 |
| 4 | `setver=` 的 pid 非法 | | 4 | `setver=` 的 pid 非法 |
| 5 | `setver=` 无法根据分支名计算 bid | | 5 | `setver=` 无法根据分支名计算 bid |
| 6 | `setver=` 未找到当前分支格式 tag |
| 9 | `setver=` 获取当天分支提交次数失败 | | 9 | `setver=` 获取当天分支提交次数失败 |
| 15 | 回写流程未识别源码类型 | | 15 | 回写流程未识别源码类型 |
| 16 | 回写流程识别到 Python，请改用 nuitka 命令 | | 16 | 回写流程识别到 Python，请改用 nuitka 命令 |
| 17 | `nuitkabuild=` 参数不足（缺少 mainPy） | | 17 | `nuitkabuild=` 参数不足（缺少 mainPy） |
| 18 | `nuitkabuild=` 的 pid 非法 | | 18 | `nuitkabuild=` 的 pid 非法 |
| 19 | `nuitkabuild=` 无法根据分支名计算 bid | | 19 | `nuitkabuild=` 无法根据分支名计算 bid |
| 20 | `nuitkabuild=` 未找到当前分支格式 tag |
| 21 | `nuitkabuild=` 获取当天分支提交次数失败 | | 21 | `nuitkabuild=` 获取当天分支提交次数失败 |
| 22 | `rewrite` 参数非法（PEType 非法或重复） | | 22 | `rewrite` 参数非法（PEType 非法或重复） |
| 23 | `repodir=` 不是有效目录 | | 23 | `repodir=` 不是有效目录 |
| 24 | `nuitkapydbuild=` 参数不足（缺少 modulePy） | | 24 | `nuitkapydbuild=` 参数不足（缺少 modulePy） |
| 25 | `nuitkapydbuild=` 的 pid 非法 | | 25 | `nuitkapydbuild=` 的 pid 非法 |
| 26 | `nuitkapydbuild=` 无法根据分支名计算 bid | | 26 | `nuitkapydbuild=` 无法根据分支名计算 bid |
| 27 | `nuitkapydbuild=` 未找到当前分支格式 tag |
| 28 | `nuitkapydbuild=` 获取当天分支提交次数失败 | | 28 | `nuitkapydbuild=` 获取当天分支提交次数失败 |
| 29 | 无参数模式下无法获取当前分支 | | 29 | 无参数模式下无法获取当前分支 |
| 30 | 无参数模式下读取标签列表失败 | | 30 | 无参数模式下读取标签列表失败 |
@@ -279,12 +273,12 @@ gitver setver=5
# 返回码: 0 # 返回码: 0
``` ```
### 验证 `-f`（无 tag 时使用默认版本） ### 验证无 tag 时自动使用默认版本
```bash ```bash
git checkout -b newbranch git checkout -b newbranch
gitver setver=5 -f gitver setver=5
# 预期: ProductVersion=5.<bid>.1.0 # 预期: ProductVersion=5.<bid>.1.0（无 tag 自动回落默认 1.0）
# 返回码: 0 # 返回码: 0
``` ```
@@ -343,7 +337,6 @@ gitver setver=5 -setup=0
| 命令 | 预期返回码 | | 命令 | 预期返回码 |
|---|---| |---|---|
| `gitver setver=5` | 0 | | `gitver setver=5` | 0 |
| `gitver setver=5 -f` | 0 |
| `gitver setver=5 -test` | 0 | | `gitver setver=5 -test` | 0 |
| `gitver setver=5 repodir=E:\NotExists` | 23 | | `gitver setver=5 repodir=E:\NotExists` | 23 |
| `gitver setver=5 -setup=0` | 0 / 37 / 38 / 39 | | `gitver setver=5 -setup=0` | 0 / 37 / 38 / 39 |
@@ -354,8 +347,7 @@ gitver setver=5 -setup=0
| 命令 | 预期返回码 | | 命令 | 预期返回码 |
|---|---| |---|---|
| `gitver nuitkabuild=5 main.py` | 0 / 19 / 20 / 21 | | `gitver nuitkabuild=5 main.py` | 0 / 19 / 21 |
| `gitver nuitkabuild=5 main.py -f` | 0 |
| `gitver nuitkabuild=5 main.py -test` | 0 | | `gitver nuitkabuild=5 main.py -test` | 0 |
| `gitver nuitkabuild=5 main.py params="--standalone"` | 0 | | `gitver nuitkabuild=5 main.py params="--standalone"` | 0 |
| `gitver nuitkabuild=5 main.py repodir=E:\NotExists` | 23 | | `gitver nuitkabuild=5 main.py repodir=E:\NotExists` | 23 |
@@ -365,8 +357,8 @@ gitver setver=5 -setup=0
| 命令 | 预期返回码 | | 命令 | 预期返回码 |
|---|---| |---|---|
| `gitver nuitkapydbuild=5 module.py` | 0 / 26 / 27 / 28 | | `gitver nuitkapydbuild=5 module.py` | 0 / 26 / 28 |
| `gitver nuitkapydbuild=5 module.py -f` | 0 | | `gitver nuitkapydbuild=5 module.py -test` | 0 |
| `gitver nuitkapydbuild=5 module.py params="--output-dir=dist"` | 0 | | `gitver nuitkapydbuild=5 module.py params="--output-dir=dist"` | 0 |
| `gitver nuitkapydbuild=5 module.py repodir=E:\NotExists` | 23 | | `gitver nuitkapydbuild=5 module.py repodir=E:\NotExists` | 23 |
| `gitver nuitkapydbuild=5` | 24 | | `gitver nuitkapydbuild=5` | 24 |