vmoon/gitlab-ci-android

gitlab-ci-android Docker镜像文档

镜像概述与主要用途

gitlab-ci-android是一个预配置的Docker镜像，集成了Android SDK及构建Android应用所需的大多数常见依赖包。该镜像专为在GitLab CI/CD等持续集成环境中高效构建Android应用而设计，通过优化依赖管理和支持CI环境缓存机制，显著提升Android应用的自动化构建效率。

核心功能与特性

• 完整的Android开发环境：内置Android SDK及常用构建工具、平台工具和依赖库，满足Android应用构建的基础需求。
• CI环境适配：针对GitLab CI等CI工具的运行环境优化，支持标准CI流程中的构建任务执行。
• 依赖缓存支持：兼容CI环境的缓存机制，通过缓存Gradle依赖等数据，大幅减少重复构建时间，尤其适用于多构建任务场景。
• 简化配置：无需手动配置Android开发环境，直接集成到CI流程中即可开始构建。

使用场景与适用范围

• GitLab CI/CD环境：作为Android应用项目的CI构建环境，自动化执行代码编译、APK打包等任务。
• 多构建任务场景：在包含多个并行或串行构建任务的CI流程中，通过缓存机制保持高效构建速度。
• Android应用自动化构建：适用于需要频繁生成调试版或发布版APK的开发团队，实现构建流程标准化。

使用方法与配置说明

基础CI配置示例

在GitLab CI项目中，通过.gitlab-ci.yml文件引用该镜像并配置构建流程。以下是基础构建配置示例：

yaml
image: jangrewe/gitlab-ci-android

stages:
  - build

before_script:
  - export GRADLE_USER_HOME=$(pwd)/.gradle  # 设置Gradle用户目录，用于缓存依赖
  - chmod +x ./gradlew  # 赋予Gradle wrapper执行权限

cache:
  key: ${CI_PROJECT_ID}  # 使用项目ID作为缓存键，确保缓存隔离
  paths:
    - .gradle/  # 缓存Gradle依赖目录，加速后续构建

build:
  stage: build
  script:
    - ./gradlew assembleDebug  # 执行Gradle命令构建调试版APK
  artifacts:
    paths:
      - app/build/outputs/apk/app-debug.apk  # 保存构建产物APK

配置说明

• 镜像引用：通过image: jangrewe/gitlab-ci-android指定使用该镜像作为CI构建环境。
• 缓存配置：cache部分定义Gradle依赖缓存路径（.gradle/），并使用项目ID作为缓存键，确保不同项目缓存独立。
• 前置脚本：before_script中设置GRADLE_USER_HOME环境变量将依赖存储在项目目录，便于CI缓存；通过chmod +x ./gradlew确保Gradle wrapper可执行。
• 构建脚本：script中通过./gradlew assembleDebug执行调试版APK构建命令。
• 构建产物：artifacts指定APK产物路径，确保构建完成后可在CI界面下载。

注意事项

• 缓存启用：确保CI环境缓存功能正常，这是提升多任务构建效率的关键。
• 权限检查：首次运行时需确认gradlew文件权限，避免因权限不足导致构建失败。
• 产物路径调整：根据实际项目结构修改artifacts.paths中的APK路径，确保正确捕获构建产物。