GitVersion 配置不递增

Posted 2023-03-07

【中文标题】GitVersion 配置不递增

【英文标题】：GitVersion configuration is not incrementing

【发布时间】：2020-02-23 22:23:53

【问题描述】：

我正在尝试设置 GitVersion 来处理我们项目的语义版本控制 (GitFlow)，但它并没有像我预期的那样自动递增。我也在努力阅读项目的文档，这不是最容易理解的。

基本上，我们希望建立一个具有 Major.Minor.Patch 约定的版本控制系统，我们手动增加 Major，当发布分支合并到 master 时自动增加 Minor，当功能分支合并到 develop 时自动增加 P​​atch。

这是我目前的GitVersion.yml

mode: ContinuousDeployment
branches:
  feature:
    increment: Patch
    regex: feature?[/-]
  release:
    increment: Minor
    regex: release?[/-]
  develop:
    regex: develop$
  master:
    regex: master$
ignore:
  sha: []

为了测试它，我编写了一个小的 ruby​​ 脚本来加快繁琐的过程。我包含它只是为了确保我以预期的方式使用 GitVersion 和 GitFlow。

require "git"

def new_feature_branch i
  g = Git.open(Dir.pwd)

  branch_name = "feature/number-#i"
  g.checkout("develop")
  g.branch(branch_name).checkout

  open('README.md', 'a') do |f|
    f.puts "\r#i"
  end

  g.add("README.md")
  g.commit("##i")

  g.branch("develop").checkout
  g.merge(branch_name)
  g.branch(branch_name).delete

  print(`gitversion`)
end


new_feature_branch(ARGV[0])

gitversion的输出

  "Major":1,
  "Minor":1,
  "Patch":0,
  "PreReleaseTag":"alpha.39",
  "PreReleaseTagWithDash":"-alpha.39",
  "PreReleaseLabel":"alpha",
  "PreReleaseNumber":39,
  "WeightedPreReleaseNumber":39,
  "BuildMetaData":"",
  "BuildMetaDataPadded":"",
  "FullBuildMetaData":"Branch.develop.Sha.57a536a5c6b6abb4313a2067468413447cb49c86",
  "MajorMinorPatch":"1.1.0",
  "SemVer":"1.1.0-alpha.39",
  "LegacySemVer":"1.1.0-alpha39",
  "LegacySemVerPadded":"1.1.0-alpha0039",
  "AssemblySemVer":"1.1.0.0",
  "AssemblySemFileVer":"1.1.0.0",
  "FullSemVer":"1.1.0-alpha.39",
  "InformationalVersion":"1.1.0-alpha.39+Branch.develop.Sha.57a536a5c6b6abb4313a2067468413447cb49c86",
  "BranchName":"develop",
  "Sha":"57a536a5c6b6abb4313a2067468413447cb49c86",
  "ShortSha":"57a536a",
  "NuGetVersionV2":"1.1.0-alpha0039",
  "NuGetVersion":"1.1.0-alpha0039",
  "NuGetPreReleaseTagV2":"alpha0039",
  "NuGetPreReleaseTag":"alpha0039",
  "VersionSourceSha":"27938c50fc6f364eff52bccec8dbc10297bce87b",
  "CommitsSinceVersionSource":39,
  "CommitsSinceVersionSourcePadded":"0039",
  "CommitDate":"2019-10-28"

每次我将功能分支合并到开发中时，我希望补丁编号会增加，但这并没有发生。

【问题讨论】：

版本号写在哪里？我猜它在某个文件中？您使用哪种语言？

我不确定我是否理解，您是指gitversion /version 的输出还是只是gitversion 的输出。我编辑了问题以包括后者。

你检查你的有效设置了吗？ gitversion /showconfig 我猜develop:increment 可能不是你所期望的（补丁）。

@8DH 谢谢，自 OP 以来我已经更新了配置设置。我在下面的答案是当前的配置文件比预期的要好得多。

【参考方案1】：

还有一些小问题，但这个配置设置比我预期的要好得多。

mode: Mainline
tag-prefix: '[vV]'
commit-message-incrementing: MergeMessageOnly
branches:
  feature:
    regex: feature?[/-]
    source-branches: ['develop']
  release:
    increment: Minor
    regex: release?[/-]
  develop:
    is-mainline: true
    increment: Patch
    regex: develop$
  master:
    regex: master$

【讨论】：

a) 这些小问题是什么？ b) 我在文档中找不到MergeMessageOnly - 你是怎么知道的？

【参考方案2】：

这不是一个真正的答案，因为您想使用 gitversion，但也许它显示了一种不同的方式来处理您的问题，并且评论太长了：

在/.git/hooks/ 中放入一个包含以下内容的文件“pre-commit” 在我们的例子中，我们正在使用R，并且版本在包文件夹中名为“DESCRIPTION”的文件中“跟踪”（这就是为什么我要求提供该文件以及如何调用它。

如果你随后提交，补丁会增加 +1，次要/主要版本必须以 x+1.0.-1 的方式手动设置（得到 x+1.0.0）。我想您应该能够根据需要调整脚本。

希望对您有所帮助。

#!C:/R/R-3.3.0/bin/x64/Rscript

# License: CC0 (just be nice and point others to where you got this)
# Author: Robert M Flight <[e-mail]>, github.com/rmflight
#
# This is a pre-commit hook that checks that there are files to be committed, and if there are, increments the package version
# in the DESCRIPTION file.
#
# To install it, simply copy this into the ".git/hooks/pre-commit" file of your git repo, change /path/2/Rscript, and make it
# executable. Note that /path/2/Rscript is the same as your /path/2/R/bin/R, or may be in /usr/bin/Rscript depending on your
# installation. This has been tested on both Linux and Windows installations.
#
# In instances where you do NOT want the version incremented, add the environment variable inc=FALSE to your git call.
# eg "inc=FALSE git commit -m "commit message".
# This is useful when you change the major version number for example.

inc <- TRUE # default

# get the environment variable and modify if necessary
tmpEnv <- as.logical(Sys.getenv("inc"))
if (!is.na(tmpEnv)) 
  inc <- tmpEnv


# check that there are files that will be committed, don't want to increment version if there won't be a commit
fileDiff <- system("git diff HEAD --name-only", intern = TRUE)

if ((length(fileDiff) > 0) && inc) 

  currDir <- getwd() # this should be the top level directory of the git repo
  currDCF <- read.dcf("DESCRIPTION")
  currVersion <- currDCF[1,"Version"]
  splitVersion <- strsplit(currVersion, ".", fixed = TRUE)[[1]]
  nVer <- length(splitVersion)
  currEndVersion <- as.integer(splitVersion[nVer])
  newEndVersion <- as.character(currEndVersion + 1)
  splitVersion[nVer] <- newEndVersion
  newVersion <- paste(splitVersion, collapse = ".")
  currDCF[1,"Version"] <- newVersion
  currDCF[1, "Date"] <- strftime(as.POSIXlt(Sys.Date()), "%Y-%m-%d")
  write.dcf(currDCF, "DESCRIPTION")
  system("git add DESCRIPTION")
  cat("Incremented package version and added to commit!\n")