GitVersion项目：如何防止主分支提交自动递增版本号

在软件开发过程中，版本控制是至关重要的环节。GitVersion作为一款流行的版本号自动生成工具，能够根据Git仓库的状态自动计算语义化版本号。然而，许多团队在使用GitVersion时会遇到一个常见问题：主分支(master)上的每次提交都会自动递增版本号，这与某些团队的版本管理策略不符。

问题背景

默认情况下，GitVersion采用GitFlow工作流，其中主分支的配置会导致每次提交后版本号自动递增。例如，当主分支上有一个标记为1.0.0的提交后，后续提交的版本号会变为1.0.1-1、1.0.1-2等。这种自动递增行为可能不符合某些团队希望完全通过标签控制主分支版本号的策略。

解决方案

要解决这个问题，我们需要完全自定义GitVersion的配置，覆盖默认的工作流设置。以下是关键配置步骤：

1. 清空工作流模板：首先需要清空默认的工作流模板，通过设置workflow: ''来实现。

2. 配置版本号生成策略：明确指定版本号生成策略为TaggedCommit，确保版本号完全基于标签。

3. 禁用自动递增：在全局和分支级别都设置increment: None，并禁用提交消息导致的版本递增。

4. 自定义分支配置：为主分支(master)和发布分支(release)分别定义精确的行为。

完整配置示例

workflow: ''
assembly-versioning-scheme: MajorMinorPatch
assembly-file-versioning-scheme: MajorMinorPatchTag
assembly-informational-format: '{InformationalVersion}'
mode: ContinuousDelivery
increment: None
tag-prefix: '[v]'
commit-message-incrementing: Disabled
commit-date-format: 'yyyy-MM-dd'
tag-pre-release-weight: 60000
strategies: [TaggedCommit]
branches:
  master:
    regex: ^master$
    label: ''
    increment: None
    track-merge-target: false
    tracks-release-branches: false
    is-release-branch: false
  release:
    regex: ^release?[/-]
    label: beta
    increment: None
    track-merge-target: true
    tracks-release-branches: true
    is-release-branch: true

配置解析

1. workflow: ''：清空默认工作流模板，从头开始定义配置。

2. strategies: [TaggedCommit]：指定版本号生成策略仅基于标签，忽略其他因素。

3. increment: None：全局禁用版本号自动递增功能。

4. master分支配置：

   • 禁用标签(label)
   • 禁用递增(increment: None)
   • 关闭合并目标跟踪(track-merge-target: false)

5. release分支配置：

   • 使用beta作为预发布标签
   • 启用合并目标跟踪
   • 标记为发布分支

效果验证

应用此配置后，主分支的版本号行为将变为：

• 标记为1.0.0的提交：1.0.0
• 后续提交1：1.0.0-1
• 后续提交2：1.0.0-2
• 后续提交3：1.0.0-3

这样就能确保主分支的正式版本号完全由标签控制，而不会因为提交而自动递增。

最佳实践建议

1. 明确版本策略：在项目开始前，团队应明确版本号管理策略。

2. 文档化配置：将GitVersion配置及其含义记录在项目文档中。

3. 持续验证：在CI/CD流水线中加入版本号验证步骤，确保符合预期。

4. 分支策略：考虑是否需要区分main和master分支，保持一致性。

通过这种配置方式，团队可以更精确地控制版本号的生成逻辑，使其完全符合项目的发布管理需求。