Gradle Advanced Build Version 插件使用教程

Gradle Advanced Build Version 插件使用教程

gradle-advanced-build-version A plugin to generate the Android version code and version name automatically based on git commits number, date and ... 项目地址: https://gitcode.com/gh_mirrors/gr/gradle-advanced-build-version

1. 项目介绍

Gradle Advanced Build Version 是一个用于自动生成 Android 版本代码和版本名称的 Gradle 插件。该插件基于 Git 提交次数、日期和语义化版本控制，帮助开发者自动管理应用的版本信息。通过使用该插件，开发者可以简化版本管理流程，确保每次构建的版本信息都是最新的。

2. 项目快速启动

2.1 安装插件

首先，将 gradle-advanced-build-version 插件添加到你的 build.gradle 文件中。

使用插件 DSL:

plugins {
    id "me.moallemi.advanced-build-version" version "3.0.0"
}

使用传统插件应用方式:

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'me.moallemi.gradle:advanced-build-version:3.0.0'
    }
}

apply plugin: 'me.moallemi.advanced-build-version'

2.2 配置版本名称和版本代码

在 build.gradle 文件中配置版本名称和版本代码。

版本名称配置:

advancedVersioning {
    nameOptions {
        versionMajor 1
        versionMinor 3
        versionPatch 6
        versionBuild 8
    }
}

上述配置将输出版本名称为 1.3.6.8。

版本代码配置:

advancedVersioning {
    codeOptions {
        versionCodeType 'GIT_COMMIT_COUNT'
    }
}

上述配置将根据 Git 提交次数自动生成版本代码。

2.3 输出 APK 文件重命名

你还可以通过插件重命名生成的 APK 文件。

advancedVersioning {
    outputOptions {
        renameOutput true
        nameFormat '$[appName]-$[buildType]-$[versionName]'
    }
}

3. 应用案例和最佳实践

3.1 自动化版本管理

在持续集成（CI）环境中，使用 gradle-advanced-build-version 插件可以自动生成版本信息，确保每次构建的版本都是唯一的。例如，在 Jenkins 或 GitHub Actions 中，可以通过插件自动生成版本名称和版本代码，减少手动干预。

3.2 多渠道发布

在多渠道发布场景中，可以通过插件自动生成不同渠道的 APK 文件名，便于管理和分发。例如，为 Google Play 和国内应用市场生成不同的 APK 文件名。

4. 典型生态项目

4.1 Android Gradle Plugin

gradle-advanced-build-version 插件与 Android Gradle Plugin 紧密集成，适用于 Android 项目的版本管理。通过该插件，开发者可以轻松管理 Android 应用的版本信息，确保每次构建的版本都是最新的。

4.2 CI/CD 工具

该插件适用于各种 CI/CD 工具，如 Jenkins、CircleCI 和 GitHub Actions。通过在 CI/CD 流程中集成该插件，可以自动化版本管理，减少手动操作，提高开发效率。

通过以上步骤，你可以快速上手并使用 gradle-advanced-build-version 插件，简化 Android 项目的版本管理流程。

gradle-advanced-build-version A plugin to generate the Android version code and version name automatically based on git commits number, date and ... 项目地址: https://gitcode.com/gh_mirrors/gr/gradle-advanced-build-version