自动增加 R 包的版本

Question

问题

我正在开发一个 R 包，我想在每次构建它时自动增加版本。我希望它能够将我的结果与包版本相关联。现在我正在使用我自己的 ugly 函数来做到这一点。

我的问题是：有没有办法做得更好？或者，我一般应该避免这样做吗？

另一种选择

我正在考虑的另一个选项是使用“devtools::install_github”安装我的包（托管在 github），然后将我的结果（或添加到绘图）保存在已安装的说明文件中的 GithubSHA1 一起保存。

例如，我可以获取 'devtools' 包的版本和 GithubSHA1：

read.dcf(file=system.file("DESCRIPTION", package="devtools"), 
         fields=c("Version", "GithubSHA1"))
 ##      Version    GithubSHA1                                
 ## [1,] "1.5.0.99" "3ae58a2a2232240e67b898f875b8da5e57d1b3a8"

我目前的尝试

我编写了以下函数来生成一个新的说明文件，其中包含更新的版本和日期。 （我不介意增加主版本）

incVer <- function(pkg, folder=".", increase="patch"){
    ## Read DESCRIPTION from installed package ´pkg´ and make new one on the specified
    ## ´folder´. Two options for ´increase´ are "patch" and "minor"
    f <- read.dcf(file=system.file("DESCRIPTION", package=pkg),
                  fields=c("Package", "Type", "Title", "Version", "Date", 
                           "Author", "Maintainer", "Description", "License", 
                           "Depends", "Imports", "Suggests"))
    curVer <- package_version(f[4])
    if(increase == "patch") {
        curVer[[1,3]] <- ifelse(is.na(curVer$patchlevel), 1, curVer$patchlevel + 1)

    } else if (increase == "minor") {
        curVer[[1,2]] <- ifelse(is.na(curVer$minor), 1, curVer$minor + 1)
        curVer[[1,3]] <- 0
    } else {
        stop(paste("Can not identify the increase argument: " , increase))
    }

    f[4] <- toString(curVer)
    ## Update also the date
    f[5] <- format (Sys.time(), "%Y-%m-%d")
    write.dcf(f, file=paste(folder, "DESCRIPTION", sep="/"))
}

Answer 1

由于自动递增版本编号是 not going to be built 到 devtools 包中，我想出了一种基于 Gabor's answer 的方法（他的答案中指向 igraph 的链接已经死了顺便说一句）。

当我即将提交到我们的存储库时，我运行这个 bash 脚本来将日期设置为今天，并根据最新的标签 .9000 后缀设置版本号（正如 Hadley Wickham 建议的 here in the book R Packages）以及该标签内的提交次数：

echo "••••••••••••••••••••••••••••••••••••••••••••"
echo "• Updating package date and version number •"
echo "••••••••••••••••••••••••••••••••••••••••••••"
sed -i -- "s/^Date: .*/Date: $(date '+%Y-%m-%d')/" DESCRIPTION
# get latest tags
git pull --tags --quiet
current_tag=`git describe --tags --abbrev=0 | sed 's/v//'`
current_commit=`git describe --tags | sed 's/.*-\(.*\)-.*/\1/'`
# combine tag (e.g. 0.1.0) and commit number (like 40) increased by 9000 to indicate beta version
new_version="$current_tag.$((current_commit + 9000))" # results in 0.1.0.9040
sed -i -- "s/^Version: .*/Version: ${new_version}/" DESCRIPTION
echo "First 3 lines of DESCRIPTION:"
head -3 DESCRIPTION
echo
# ... after here more commands like devtools::document() and git commit

要清楚 - 这个脚本实际上对 DESCRIPTION 文件进行了这些更改。

编辑：支持数百个 - 现在只需将提交序列号增加 9000。因此标签 v0.6.1 中的提交 #120 导致 0.6.1.9120。

Answer 2

对于更简单的方法，请考虑使用带有-u 开关的crant 工具。例如，

crant -u 3

将版本的第三个组件加一。还有 Git 和 SVN 集成，以及许多其他有用的开关，用于 roxygenizing、构建、检查等。

Answer 3

如果你使用的是 git，那么你可以使用 git 标签来创建一个版本字符串。这就是我们生成 igraph 库的版本字符串的方式：

git describe HEAD --tags | rev | sed 's/g-/./' | sed 's/-/+/' | rev

它为您提供如下格式：

0.8.0-pre+131.ca78343

0.8.0-pre 是当前分支的最后一个标签。 （最后发布的版本是 0.7.1，我们在发布标签之后立即创建一个-pre 标签。）131 是自上一个标签以来的提交次数。 ca78343 是最后一次提交的十六进制 id 的前七个字符。

这很好，除了你不能在 R 包中包含这样的版本字符串，R 不允许它。因此，对于 R，我们使用以下脚本转换此版本字符串：https://github.com/igraph/igraph/blob/develop/interfaces/R/tools/convertversion.sh

本质上，它创建的版本号大于上一个发布版本，小于下一个版本（-pre 标记中的那个）。它从0.8.0-pre+131.ca78343 创建

0.7.999-131

其中131 是自上次发布以来的提交次数。

我将DESCRIPTION 文件的生成放在一个Makefile 中。这将替换日期和版本号：

VERSION=$(shell ./tools/convertversion.sh)

igraph/DESCRIPTION: src/DESCRIPTION version_number
        sed 's/^Version: .*$$/Version: '$(VERSION)'/' $<     | \
        sed 's/^Date: .*$$/Date: '`date "+%Y-%m-%d"`'/' > $@

这很方便，你不需要做任何事情，除了添加发布标签和 -pre 标签。

顺便说一句。这主要是由我的朋友和 igraph 的共同开发者 Tamás Nepusz 完成的，所以功劳是他的。