将其他 Git 仓库中的库源代码复制到 Android Gradle 应用程序的 GitLab 构建流程

69次阅读

问题描述

在使用 GitLab CI/CD 针对其 Android 应用程序进行构建时遇到了问题。该应用程序使用了一个在 build.gradle 文件中声明的“library”依赖：

dependencies {
    api project(path: ':specialproject.speciallibrary', configuration: 'default')
}

这个依赖在 settings.gradle 中进行了配置：

include ':specialproject.speciallibrary'
project(':specialproject.speciallibrary').projectDir = new File('../specialprojectlibrary')

开发人员目前在其计算机上同时拥有主项目和 specialprojectlibrary 项目的源代码。因此，在构建应用程序时，Gradle 会在构建主应用程序（APK）时获取 specialprojectlibrary 并对其进行构建。

然而，当他们希望为应用程序创建 GitLab CI/CD 流程时，出现了错误：

FAILURE: Build failed with an exception.
* What went wrong:
Could not determine the dependencies of task ':something:xyz'.
> Could not resolve all task dependencies for configuration ':something:xyz'.
   > Could not resolve project :specialproject.speciallibrary.
     Required by:
         project :mainproject
      > Project :mainproject declares a dependency from configuration 'api' to configuration 'default' which is not declared in the descriptor for project :specialproject.speciallibrary.

用户猜测这是因为 GitLab CI/CD 的主应用程序 Gradle 无法访问 specialprojectlibrary 下的库源代码。

因此，用户的问题是：
如何将来自其他 Git 仓库的库源代码复制到 Android Gradle 应用程序的 GitLab 构建流程中？

解决方案

请注意以下操作注意版本差异及修改前做好备份。

方案1: 使用 Git 子模块

您需要将库作为 Git 子模块添加到应用程序仓库中。然后，在设置 GitLab CI 时，确保在构建之前检出子模块。
这不仅使得 CI 可以正常工作，而且作为额外的好处，应用程序仓库的每个提交将引用库仓库的特定提交，这样就不必记住在库仓库中检出哪个提交来确保应用程序正确构建。

步骤:

将库作为 Git 子模块添加到应用程序仓库。假设库仓库的 URL 为 <library_repository_url>。

git submodule add <library_repository_url> specialproject.speciallibrary

编辑 .gitmodules 文件，添加子模块的路径和 URL。
提交修改。
在 GitLab CI/CD 配置中，添加检出子模块的步骤。

stages:
  - build

build:
  stage: build
  script:
    - git submodule sync --recursive
    - git submodule update --init --recursive
    # 其他构建步骤...

方案2: 使用脚本控制复制

另一种方法是使用脚本来控制库源代码的复制。您可以在 GitLab CI/CD 中编写脚本来从库仓库复制源代码，然后再进行构建。

步骤:

在 GitLab CI/CD 配置中，添加脚本来复制库源代码。

stages:
  - copy_source
  - build

copy_source:
  stage: copy_source
  script:
    - git clone <library_repository_url> specialproject.speciallibrary
    # 可以添加其他脚本来处理复制后的源代码，例如复制到特定目录等

build:
  stage: build
  script:
    # 构建应用程序...

注意: 这种方法需要确保库仓库的访问权限，同时需要处理复制后源代码的一些细节，例如复制到特定目录。