Gradle Android Git Version 插件使用教程

Gradle Android Git Version 插件使用教程

gradle-android-git-versionA gradle plugin to calculate Android-friendly version names and codes from git tags项目地址:https://gitcode.com/gh_mirrors/gr/gradle-android-git-version

项目介绍

gradle-android-git-version 是一个 Gradle 插件，旨在从 Git 标签中计算出适用于 Android 的版本名称和代码。如果你厌倦了手动更新 Android 构建文件以适应每次发布，或者生成的构建无法追溯到代码，那么这个插件非常适合你。

项目快速启动

安装步骤

1. 添加插件到项目： 在你的 app/build.gradle（或等效文件）顶部添加插件块：

   plugins {
       id 'com.gladed.androidgitversion' version '0.4.14'
   }
   

2. 从插件结果设置 versionName 和 versionCode：

   android {
       defaultConfig {
           versionName androidGitVersion.name()
           versionCode androidGitVersion.code()
       }
   }
   

3. 使用 Git 标签指定版本号：

   $ git tag 1.2.3
   $ gradle --quiet androidGitVersion
   androidGitVersion.name: 1.2.3
   androidGitVersion.code: 1002003
   

应用案例和最佳实践

高级用法

• 标签格式： 标签应类似于 1 或 3.14 或 1.12.5。至少需要一个这种格式的标签可从当前提交访问，否则生成的版本名称或代码将出错。

• 配置属性： 你可以通过在项目的 build.gradle 文件中添加 androidGitVersion 块来配置名称和代码的生成方式：

  androidGitVersion {
      abis = ["armeabi":1, "armeabi-v7a":2]
      baseCode = 200000
      codeFormat = 'MNNPPP'
      commitHashLength = 8
      format = '%tag%%count%%<commit>%%-branch%%dirty%'
      hideBranches = ["master", "develop"]
  }
  

最佳实践

• 确保足够的 Git 历史： 在 CI 环境中，确保拉取足够的提交历史（例如 git fetch --depth=100 --tags）以访问最近的提交和标签。

• 避免隐藏分支： 配置 hideBranches 以避免在版本名称中包含特定分支信息。

典型生态项目

gradle-android-git-version 插件通常与其他 Android 开发工具和插件一起使用，例如：

• Android Gradle Plugin：用于构建 Android 应用。
• Gradle Versions Plugin：用于检查项目依赖项的更新。
• Detekt：用于静态代码分析，提高代码质量。

这些工具共同构成了一个强大的 Android 开发生态系统，帮助开发者高效地管理和构建项目。

gradle-android-git-versionA gradle plugin to calculate Android-friendly version names and codes from git tags项目地址:https://gitcode.com/gh_mirrors/gr/gradle-android-git-version