我需要编写一个Gradle脚本,以便在每次提交时自动对我的应用程序进行版本控制。 我还需要在应用程序中包含提交哈希作为测试人员的参考。
我不太清楚自动版本控制通常是如何工作的。 有人可以解释一下自动版本控制的过程吗?
我需要编写一个Gradle脚本,以便在每次提交时自动对我的应用程序进行版本控制。 我还需要在应用程序中包含提交哈希作为测试人员的参考。
我不太清楚自动版本控制通常是如何工作的。 有人可以解释一下自动版本控制的过程吗?
我曾经遇到过类似的问题,但不想修改versionName来包含git哈希值。我们想保持它像1.2.2那样,但仍然有可能在UI中显示git哈希值。
我从这里的其他答案修改了代码,使用buildConfigField任务来生成一个BuildConfig.GitHash值,该值可以在Java代码中引用。
将以下内容添加到模块的build.gradle文件的android
部分之前:
def getGitHash = { ->
def stdout = new ByteArrayOutputStream()
exec {
commandLine 'git', 'rev-parse', '--short', 'HEAD'
standardOutput = stdout
}
return stdout.toString().trim()
}
然后在 build.gradle 文件中 android
部分的 defaultConfig
部分中添加以下行,即在 versionName
下面:
buildConfigField "String", "GitHash", "\"${getGitHash()}\""
这将在自动生成的BuildConfig.java文件中生成以下行:
// Fields from default config.
public static final String GitHash = "e61af97";
现在您可以在Java代码中使用BuildConfig.GitHash
获取git哈希。
一个理想的解决方案是从项目的git状态中获取版本号。这样,版本控制不依赖于您记得要增加变量或更改gradle或配置文件中的任何文本。另一个优点是将版本名称和代码追溯到一个特定的代码状态。
在http://ryanharter.com/blog/2013/07/30/automatic-versioning-with-git-and-gradle/中可以找到一个描述性的例子。
该思路是使用getVersionName函数获取git信息,并在gradle脚本中使用该函数:
/*
* Gets the version name from the latest Git tag
*/
def getVersionName = { ->
def stdout = new ByteArrayOutputStream()
exec {
commandLine 'git', 'describe', '--tags'
standardOutput = stdout
}
return stdout.toString().trim()
}
kts:
val gitDescribe: String by lazy {
val stdout = ByteArrayOutputStream()
rootProject.exec {
commandLine("git", "describe", "--tags")
standardOutput = stdout
}
stdout.toString().trim()
/* 'g' doesn't belong to the commit id and stands for 'git'
v0.1.9-1-g3a259e0 -> v0.1.9-1-3a259e0
if you like this to be removed then */
//.replace("-g", "-")
}
git describe --tags
以生成信息)。将以下代码添加到你的build.gradle文件中
def gitCommitHash = 'git rev-parse --verify --short HEAD'.execute().text.trim()
defaultConfig{
... otherConfigs
buildConfigField("String", "GIT_HASH", "\"${gitCommitHash}\"")
}
现在您可以通过BuildConfig.GIT_HASH
获取git哈希值。
玩得开心!
plugins {
id "com.peterabeles.gversion" version "1.2.4"
}
gversion {
srcDir = "src/main/java/"
classPackage = "com.your.package"
className = "MyVersion" // optional. If not specified GVersion is used
dateFormat = "yyyy-MM-dd'T'HH:mm:ss'Z'" // optional. This is the default
timeZone = "UTC" // optional. UTC is default
}
project.compileJava.dependsOn(createVersionFile)
这将使它在Gradle构建项目时每次生成该文件。有关Android说明,请参见上面的网站。/**
* Automatically generated file containing build version information.
*/
public class MyVersion {
public static final String MAVEN_GROUP = "com.your";
public static final String MAVEN_NAME = "project_name";
public static final String VERSION = "1.0-SNAPSHOT";
public static final int GIT_REVISION = 56;
public static final String GIT_SHA = "a0e41dd1a068d184009227083fa6ae276ef1846a";
public static final String BUILD_DATE = "2018-04-11T12:19:03Z";
public static final long BUILD_UNIX_TIME = 1523449143116L;
}
您可能还希望将版本文件添加到您的.gitignore中,因为它是自动生成的,您不希望在git中出现。
值得一提的是grgit - Groovy/Gradle Git,它可以帮助简化在Gradle脚本中提取信息(包括Git提交哈希)的过程。
task<Exec>("MyTask") {
doLast {
commandLine("git")
.args("rev-parse", "--verify", "--short", "HEAD")
.workingDir(rootProject.projectDir)
}
}
tasks.create("MyTask") {
val command = "git rev-parse --verify --short HEAD"
doLast {
val process = ProcessBuilder()
.command(command.split(" "))
.directory(rootProject.projectDir)
.redirectOutput(Redirect.INHERIT)
.redirectError(Redirect.INHERIT)
.start()
process.waitFor(60, TimeUnit.SECONDS)
val result = process.inputStream.bufferedReader().readText()
println(result)
}
}