【译文】配置 Android 项目系列2——版本号

说明:由于翻译水平有限,可能会存在一些不恰当的地方,欢迎指出,我会马上改正。

本文是配置 Android 项目系列的一部分:

  1. Little Things That Matter
  2. Version Name & Code
  3. Static Code Analyses Tools
  4. Continuous Integration

我们在这篇文章中讨论的一切都可以在 template 项目中找到

版本号

开发人员通常使用硬编码指定 Android 的 versionName 和 versionCode。

defaultConfig {
    ...
    versionCode 1
    versionName "1.0.0"
}

这种方法有几个缺点:

  • 你永远不知道哪个 commit 代表一个特定的版本。
  • 每当你增加 versionCode 和修改 versionName,你必须要修改 build.gradle 文件。

如果你使用 git 作为你的源代码控制系统,它也可以帮助你生成 Android versionName 和 versionCode。通常的做法是使用 git tags 标示出新发布的版本。

git_tags.png

Version Name

我们可以使用 git describe 命令描述 versionName。

a. 该命令从一个 commit 中找到可以访问的最新的标签。

b. 如果该标签指向一个 commit,则只显示该标签。

c. 否则,它将标记名称与标记对象顶部的附加提交数以及最近提交的缩写对象名称后缀。

Example (a-b)

git_describe.png
  1. 用标签 1.0 标识特定的 commit
  2. checkout 这个 commit
  3. 调用 git describe -tags
  4. 输出:1.0

正如你所看见的,如果你在一个 HEAD commit 中使用 git describe 加上一些标签,它会输出这个标签。

Example (a-c)

git_describe_2.png
  1. 用标签 1.0 标识一个 commit
  2. 增加两个 commit
  3. 调用 git describe -tags
  4. 输出:1.0-2-gdca226a
git_describe_3.png

使用 git commit 的哈希值 “1.0–2-gdca226a”,我们可以很容易的找到建立了哪个特定的 commit。

git_hash.png

Version Code

对于 versionCode 我们可以使用标签总数。因为每一个 git tag 标识一些版本,下一个版本的 versionCode 永远大于前一个的。

git_code.png

在上面的例子中有3个标签。这个值可以用来指定 versionCode。

但是我们不会为每一个中间版本创建 git tags,所以在开发版本中 HEAD commit 我们可以使用时间戳。

git_timestamp.png

在上面的例子中一个 HEAD commit 的时间戳等于1484407970(
UNIX 中自1970年1月1日00:00:00 UTC以来的秒数)。这个值将用于我们的 versionCode。如果你希望把它转换为人类可读的时间,可以使用 currentmillis.com。在我们的例子中是 Sat Jan 14 2017 15:32:50 UTC。

Groovy way to use git

配合 git 一起使用,我建议使用库 grgit。创建以下内容的 script-git-version.gradle 文件。

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'org.ajoberstar:grgit:1.5.0'
    }
}

import org.ajoberstar.grgit.Grgit

ext {
    git = Grgit.open(currentDir: projectDir)
    gitVersionName = git.describe()
    gitVersionCode = git.tag.list().size()
    gitVersionCodeTime = git.head().time
}

task printVersion() {
    println("Version Name: $gitVersionName")
    println("Version Code: $gitVersionCode")
    println("Version Code Time: $gitVersionCodeTime")
}

将它应用到你的 build.gradle 文件中。

apply plugin: 'com.android.application'
apply from: "$project.rootDir/tools/script-git-version.gradle"

检查版本名称和版本号正确地生成,可以使用 gradle 任务 ./gradlew printVersion,输出类似的:

Version Name: 1.0-2-gdca226a
Version Code: 2
Version Code Time: 1484407970

最后在你的 build.gradle 文件中使用变量 gitVersionName,gitVersionCode 和 gitVersionCodeTime。

productFlavors {
    dev {
        versionCode gitVersionCodeTime
        versionName gitVersionName
    }

    prod {
        versionCode gitVersionCode
        versionName gitVersionName
    }
}

运行项目检查应用版本。

app_info.png

这种方法的好处:

  • 不要修改 build.gradle 文件,versionCode 和 versionName 是自动生成的。
  • 你可以很容易地找到已经建立了什么 commit。

Note: 你可以尝试更多的版本名称:包括分支名、时间戳等。

译文

  1. 小事情
  2. 版本号
  3. 静态代码分析工具
  4. 持续集成
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,015评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,262评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,727评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,986评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,363评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,610评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,871评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,582评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,297评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,551评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,053评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,385评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,035评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,079评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,841评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,648评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,550评论 2 270

推荐阅读更多精彩内容