如何使用 Gitlab CI 构建 JavaMaven 项目？

我花了相当多的时间在 Gitlab CI 上设置我们的 Java 项目。我成功地把它修好了。正如 Rolve 所提到的，最直接的解决方案是使用来自官方回购的图像: https://hub.docker.com/_/maven

但是，我们有一个公司代理，它导致我的构建在获取项目的依赖项时获得超时请求。我尝试了很多解决方案，最后发现了这篇文章: https://gitlab.com/gitlab-org/gitlab-ce/issues/15167。

帖子本身是关于建立 maven 来缓存本地回购中下载的依赖关系，这些依赖关系可以在构建中访问。其思想是您可以在 . gitlab-ci. yml中编写一个本地 maven 配置文件来设置您的缓存目录和代理。

before_script:
-echo '<settings
xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
https://maven.apache.org/xsd/settings-1.0.0.xsd">
<localRepository>/cache/.m2</localRepository>
<proxies>
<proxy>
<active>true</active>
<protocol>'$PROXY_PROTOCOL'</protocol>
<host>'$PROXY_HOST'</host>
<port>'$PROXY_PORT'</port>
</proxy>
</proxies>
</settings>' > $HOME/.m2/settings.xml


build_debug1:
stage: build
script: "echo $PROXY_HOST"


build_debug2:
stage: build
script: "cat $HOME/.m2/settings.xml"


build_maven:
stage: build
script: "mvn $MAVEN_CLI_OPTS package"
artifacts:
paths:
- target/*.jar


deploy_debug1:
stage: package
script: "ls target/"

注意，构建调试作业仅用于查看是否正确注入了代理设置。您可以使用 Gitlab 将代理环境变量设置为机密，方法是进入 Project-> Settings-> CI/CD Pipes-> Secret Variables。

最后一个 deploy_debug作业是查看在目标目录中生成了什么。

在 如何使用 GitLab CI/CD 将 Maven 项目部署到 ArtiFactory的帮助下

您可以通过将一个 .gitlab-ci.yml文件添加到存储库的根目录来编译 java maven 项目，该文件包含以下内容:

image: maven:latest


variables:
MAVEN_OPTS: "-Dmaven.repo.local=.m2/repository"


cache:
paths:
- .m2/repository/
- target/


build:
stage: build
script:
- mvn compile

这里有几个问题。

我要开始回答 Java 构建的问题，然后是跑步者的。

Java 编译

我将从最基本的 Java 构建配置开始，逐步添加特性。

1. 基本 Java 构建

这个配置有望运行 Maven 构建(并且只运行构建，显式地排除单元测试) :

stages:
- build


java-build:
# select the most appropriate image for your project
image: maven:3.8-openjdk-11
stage: build
script:
- mvn package -DskipTests=true

使用工件、缓存和推荐的 Maven 选项

新版本:

• 将 Maven 构建输出声明为 GitLab 工件(供以后在下游管道中使用) ,
• 利用 GitLab 的缓存缓存本地 Maven 存储库(在 .m2/repository中) ,
• 还强制执行一些推荐的 Maven 选项，以便在 CI/CD 上下文中使用。

stages:
- build


variables:
# This will suppress any download for dependencies and plugins or upload messages which would clutter the console log.
# `showDateTime` will show the passed time in milliseconds. You need to specify `--batch-mode` to make this work.
MAVEN_OPTS: >-
-Dhttps.protocols=TLSv1.2
-Dmaven.repo.local=.m2/repository
-Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=WARN
-Dorg.slf4j.simpleLogger.showDateTime=true
-Djava.awt.headless=true
# As of Maven 3.3.0 instead of this you may define these options in `.mvn/maven.config` so the same config is used
# when running from the command line.
# `installAtEnd` and `deployAtEnd` are only effective with recent version of the corresponding plugins.
MAVEN_CLI_OPTS: >-
--batch-mode
--errors
--fail-at-end
--show-version
-DinstallAtEnd=true
-DdeployAtEnd=true


java-build:
# select the most appropriate image for your project
image: maven:3.8-openjdk-11
stage: build
# Cache downloaded dependencies and plugins between builds.
# The key here separates one cache per branch/tag ($CI_COMMIT_REF_SLUG)
cache:
key: "maven-$CI_COMMIT_REF_SLUG"
paths:
- .m2/repository
script:
- mvn $MAVEN_CLI_OPTS package -DskipTests=true
artifacts:
name: "Maven artifacts from $CI_PROJECT_NAME on $CI_COMMIT_REF_SLUG"
paths:
- "**/target"

3. 使用单元测试

在将单元测试集成到 CI/CD 管道中时，有两种选择:

1. 在与构建相同的作业中运行它们
2. 让他们分开工作

关于管道执行速度和绿色 IT 考虑，我当然更喜欢选项1，但我承认人们可能更喜欢第二个。

下面是 .gitlab-ci.yml文件的新版本，也实现了 GitLab 单元测试集成:

stages:
- build


variables:
# This will suppress any download for dependencies and plugins or upload messages which would clutter the console log.
# `showDateTime` will show the passed time in milliseconds. You need to specify `--batch-mode` to make this work.
MAVEN_OPTS: >-
-Dhttps.protocols=TLSv1.2
-Dmaven.repo.local=.m2/repository
-Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=WARN
-Dorg.slf4j.simpleLogger.showDateTime=true
-Djava.awt.headless=true
# As of Maven 3.3.0 instead of this you may define these options in `.mvn/maven.config` so the same config is used
# when running from the command line.
# `installAtEnd` and `deployAtEnd` are only effective with recent version of the corresponding plugins.
MAVEN_CLI_OPTS: >-
--batch-mode
--errors
--fail-at-end
--show-version
-DinstallAtEnd=true
-DdeployAtEnd=true


java-build-and-test:
# select the most appropriate image for your project
image: maven:3.8-openjdk-11
stage: build
# Cache downloaded dependencies and plugins between builds.
# The key here separates one cache per branch/tag ($CI_COMMIT_REF_SLUG)
cache:
key: "maven-$CI_COMMIT_REF_SLUG"
paths:
- .m2/repository
script:
# the 'verify' goal is definitely the most appropriate here
- mvn $MAVEN_CLI_OPTS verify
artifacts:
name: "Maven artifacts from $CI_PROJECT_NAME on $CI_COMMIT_REF_SLUG"
paths:
- "**/target"
reports:
# declare the JUnit reports (recursive pattern for multi-module projects)
junit:
- "**/target/*-reports/TEST-*.xml"

4. 更进一步

从这一步开始，构建作业仍然可以得到进一步的增强，例如代码覆盖率计算和 整合，但是这需要更多的代码。

另一种实现最先进的流水线的方法是使用 GitLab CI/CD 模板，这种方法的工作量要小得多:

• GitLab 的 Maven 模板
• 或 连续模板连续模板连续模板连续模板

连续 是一个开放源码项目，它提供了一系列现成的、可配置的、可扩展的、可组合的模板。

关于跑步者

GitLab 体系结构非常灵活，带有 跑步者的概念。 跑步者是基本的 遗嘱执行人池，它使得 GitLab CI/CD 作业的执行成为可能。

关于跑步者的两件有趣的事情

1. 你可以专门训练你的跑步者

使用 GitLab，您可以注册几种跑步者，这些跑步者是为特殊和互补目的而制作的。

为了使它们成为 隔离，GitLab 支持 标签的概念。当注册您的跑步者时，您应该将他们与 功能性的标记名相关联，这将帮助开发人员在他们的 .gitlab-ci.yml文件中选择最合适的一个。

例如，假设你有4个跑步者:

通过这种设置，同时使用 Java 和.NET 代码的 monorepo 项目可以声明以下 .gitlab-ci.yml文件:

stages:
- build
- test
- deploy


# this job declares no tag: will be executed by default runner (#1)
java-build:
image: maven:3.8-openjdk-11
stage: build
script:
- Java build code here


dotnet-build:
image: mcr.microsoft.com/dotnet/sdk:5.0
stage: build
tags:
- windows
- general
script:
- .NET build code here


# this job declares no tag: will be executed by default runner (#1)
java-test:
image: maven:3.8-openjdk-11
stage: test
script:
- Java test code here


dotnet-test:
image: mcr.microsoft.com/dotnet/sdk:5.0
stage: test
tags:
- windows
- general
script:
- .NET test code here


deploy:
stage: deploy
tags:
- deploy
- datacenter
script:
- deployment code here

2. 跑步者有不同的视野

引用 正式文件的话:

跑步者可以根据你想要接触的人选选择:

• GitLab 实例中的所有组和项目都可以使用共享运行程序 。
• 组长 可用于组中的所有项目和子组。
• 特定的跑步者 与特定的项目相关联。通常，特定的跑步者一次只用于一个项目。

只是检查它是否被允许，或者在 mvn build/test 命令之后添加步骤。我正在检查是否有一个选项来运行脚本后，不管构建状态。

像下面这样的东西。无论 mvn 测试状态如何，我都要在其中运行。有什么想法吗？我知道一种方法可以把它作为后期脚本运行。但是尽量避免这种情况。

build:
stage: build
script:
- mvn test
- ./extract_data.sh

#-----------Base image that contains required maven and jdk--------#
image: basebuildimage
variables:
MAVEN_CLI_OPTS: "-s .m2/settings.xml --batch-mode"
stages:
- build
#----------Build code-----------#
build:
stage: build
script:
- mvn $MAVEN_CLI_OPTS clean install