包注册表中的Maven包

将以下部分添加到您的 settings.xml 文件中：

<settings>
  <servers>
    <server>
      <id>gitlab-maven</id>
      <configuration>
        <httpHeaders>
          <property>
            <name>REPLACE_WITH_NAME</name>
            <value>REPLACE_WITH_TOKEN</value>
          </property>
        </httpHeaders>
      </configuration>
    </server>
  </servers>
</settings>

在 您的 GRADLE_USER_HOME 目录 中， 创建一个名为 gradle.properties 的文件，内容如下：

gitLabPrivateToken=REPLACE_WITH_YOUR_TOKEN

向您的 build.gradle 文件中添加一个 repositories 部分：

• 在Groovy DSL中：

  repositories {
      maven {
          url "https://gitlab.example.com/api/v4/groups/<group>/-/packages/maven"
          name "GitLab"
          credentials(HttpHeaderCredentials) {
              name = 'REPLACE_WITH_NAME'
              value = gitLabPrivateToken
          }
          authentication {
              header(HttpHeaderAuthentication)
          }
      }
  }

• 在Kotlin DSL中：

  repositories {
      maven {
          url = uri("https://gitlab.example.com/api/v4/groups/<group>/-/packages/maven")
          name = "GitLab"
          credentials(HttpHeaderCredentials::class) {
              name = "REPLACE_WITH_NAME"
              value = findProperty("gitLabPrivateToken") as String?
          }
          authentication {
              create("header", HttpHeaderAuthentication::class)
          }
      }
  }

| 令牌类型 | 名称必须为 | 令牌 |\n|———————–|——————————|————————————————————————|\n| 个人访问令牌 | 用户名 | 直接粘贴令牌，或定义环境变量保存令牌 |\n| 部署令牌 | 部署令牌的用户名 | 直接粘贴令牌，或定义环境变量保存令牌 |\n| CI作业令牌 | gitlab-ci-token | ${CI_JOB_TOKEN} |\n\n在您的 settings.xml 文件中添加以下部分：

<settings>
  <servers>
    <server>
      <id>gitlab-maven</id>
      <username>REPLACE_WITH_NAME</username>
      <password>REPLACE_WITH_TOKEN</password>
      <configuration>
        <authenticationInfo>
          <userName>REPLACE_WITH_NAME</userName>
          <password>REPLACE_WITH_TOKEN</password>
        </authenticationInfo>
      </configuration>
    </server>
  </servers>
</settings>

| 令牌类型 | 名称必须为 | 令牌 |\n|———————–|——————————|————————————————————————|\n| 个人访问令牌 | 用户名 | 直接粘贴令牌，或定义环境变量保存令牌 |\n| 部署令牌 | 部署令牌的用户名 | 直接粘贴令牌，或定义环境变量保存令牌 |\n| CI作业令牌 | gitlab-ci-token | System.getenv("CI_JOB_TOKEN") |\n\n在 您的 GRADLE_USER_HOME 目录 中，创建一个包含以下内容的 gradle.properties 文件：

gitLabPrivateToken=REPLACE_WITH_YOUR_TOKEN

在您的 build.gradle 中添加一个 repositories 部分：

• 在Groovy DSL中：

  repositories {
      maven {
          url "https://gitlab.example.com/api/v4/groups/<group>/-/packages/maven"
          name "GitLab"
          credentials(PasswordCredentials) {
              username = \'REPLACE_WITH_NAME\'
              password = gitLabPrivateToken
          }
          authentication {
              basic(BasicAuthentication)
          }
      }
  }

• 在Kotlin DSL中：

  repositories {
      maven {
          url = uri("https://gitlab.example.com/api/v4/groups/<group>/-/packages/maven")
          name = "GitLab"
          credentials(BasicAuthentication::class) {
              username = "REPLACE_WITH_NAME"
              password = findProperty("gitLabPrivateToken") as String?
          }
          authentication {
              create("basic", BasicAuthentication::class)
          }
      }
  }

| 令牌类型 | 名称必须为 | 令牌 |\n|———————–|——————————|————————————————————————|\n| 个人访问令牌 | 用户名 | 直接粘贴令牌，或定义环境变量保存令牌 |\n| 部署令牌 | 部署令牌的用户名 | 直接粘贴令牌，或定义环境变量保存令牌 |\n| CI作业令牌 | gitlab-ci-token | sys.env.get("CI_JOB_TOKEN").get |\n\nSBT 的认证基于 基本HTTP认证。您需要提供名称和密码。\n\n

credentials += Credentials("GitLab Packages Registry", "<host>", "<name>", "<token>")

无论选择哪个端点，您都必须具备：

• 在 distributionManagement 部分有一个项目特定的URL。
• 一个 repository 和 distributionManagement 部分。

您的Maven pom.xml 中相关的 repository 部分应如下所示：

<repositories>
  <repository>
    <id>gitlab-maven</id>
    <url><your_endpoint_url></url>
  </repository>
</repositories>
<distributionManagement>
  <repository>
    <id>gitlab-maven</id>
    <url>https://gitlab.example.com/api/v4/projects/<project_id>/packages/maven</url>
  </repository>
  <snapshotRepository>
    <id>gitlab-maven</id>
    <url>https://gitlab.example.com/api/v4/projects/<project_id>/packages/maven</url>
  </snapshotRepository>
</distributionManagement>

• id 是您在 settings.xml 中定义的内容。
• <your_endpoint_url> 取决于您选择的 端点。
• 将 gitlab.example.com 替换为您自己的域名。

要通过Gradle发布包：

1. 将Gradle插件 maven-publish 添加到plugins部分：

   • 在Groovy DSL中：

     plugins {
         id 'java'
         id 'maven-publish'
     }

   • 在Kotlin DSL中：

     plugins {
         java
         `maven-publish`
     }

2. 添加一个 publishing 部分：

   • 在Groovy DSL中：

     publishing {
         publications {
             library(MavenPublication) {
                 from components.java
             }
         }
         repositories {
             maven {
                 url "https://gitlab.example.com/api/v4/projects/<PROJECT_ID>/packages/maven"
                 credentials(HttpHeaderCredentials) {
                     name = "REPLACE_WITH_TOKEN_NAME"
                     value = gitLabPrivateToken // 该变量位于 $GRADLE_USER_HOME/gradle.properties
                 }
                 authentication {
                     header(HttpHeaderAuthentication)
                 }
             }
         }
     }

   • 在Kotlin DSL中：

     publishing {
         publications {
             create<MavenPublication>("library") {
                 from(components["java"])
             }
         }
         repositories {
             maven {
                 url = uri("https://gitlab.example.com/api/v4/projects/<PROJECT_ID>/packages/maven")
                 credentials(HttpHeaderCredentials::class) {
                     name = "REPLACE_WITH_TOKEN_NAME"
                     value =
                         findProperty("gitLabPrivateToken") as String? // 该变量位于 $GRADLE_USER_HOME/gradle.properties
                 }
                 authentication {
                     create("header", HttpHeaderAuthentication::class)
                 }
             }
         }
     }

要通过 Maven 发布包：

mvn deploy

如果部署成功，应显示构建成功消息：

...
[INFO] BUILD SUCCESS
...

消息还应显示包已发布到正确的位置：

Uploading to gitlab-maven: https://example.com/api/v4/projects/PROJECT_ID/packages/maven/com/mycompany/mydepartment/my-project/1.0-SNAPSHOT/my-project-1.0-20200128.120857-1.jar

运行发布任务：

gradle publish

前往项目的 Packages and registries 页面查看已发布的包。

在你的 build.sbt 文件中配置 publishTo 设置：

publishTo := Some("gitlab" at "<endpoint url>")

确保凭证引用正确。有关更多信息，请参阅 sbt 文档。

使用 sbt 发布包：

sbt publish

如果部署成功，将显示构建成功消息：

[success] Total time: 1 s, completed Jan 28, 2020 12:08:57 PM

检查成功消息以确保包已发布到正确位置：

[info]  published my-project_2.12 to https://gitlab.example.com/api/v4/projects/PROJECT_ID/packages/maven/com/mycompany/my-project_2.12/0.1.1-SNAPSHOT/my-project_2.12-0.1.1-SNAPSHOT.pom

要通过 mvn install 安装包：

1. 手动将依赖项添加到项目的 pom.xml 文件中。要添加之前创建的示例，XML 如下：

   <dependency>
     <groupId>com.mycompany.mydepartment</groupId>
     <artifactId>my-project</artifactId>
     <version>1.0-SNAPSHOT</version>
   </dependency>

2. 在您的项目中，运行以下命令：

   mvn install

消息应显示正在从包注册表下载包：

Downloading from gitlab-maven: http://gitlab.example.com/api/v4/projects/PROJECT_ID/packages/maven/com/mycompany/mydepartment/my-project/1.0-SNAPSHOT/my-project-1.0-20200128.120857-1.pom

您也可以直接使用 Maven dependency:get 命令 安装包。

1. 在项目目录中，运行：

   mvn dependency:get -Dartifact=com.nickkipling.app:nick-test-app:1.1-SNAPSHOT -DremoteRepositories=gitlab-maven::::<gitlab endpoint url>  -s <path to settings.xml>

   • <gitlab endpoint url> 是 GitLab 端点 的 URL。
   • <path to settings.xml> 是包含 验证详情 的 settings.xml 文件的路径。

消息应显示正在从包注册表下载包：

Downloading from gitlab-maven: http://gitlab.example.com/api/v4/projects/PROJECT_ID/packages/maven/com/mycompany/mydepartment/my-project/1.0-SNAPSHOT/my-project-1.0-20200128.120857-1.pom

要通过 gradle 安装包：

1. 在 build.gradle 的 dependencies 部分添加一个 依赖项：

   • 使用 Groovy DSL：

     dependencies {
         implementation 'com.mycompany.mydepartment:my-project:1.0-SNAPSHOT'
     }

   • 使用 Kotlin DSL：

     dependencies {
         implementation("com.mycompany.mydepartment:my-project:1.0-SNAPSHOT")
     }

2. 在您的项目中，运行以下命令：

   gradle install

要通过 sbt 安装包：

1. 向 build.sbt 添加一个 内联依赖项：

   libraryDependencies += "com.mycompany.mydepartment" % "my-project" % "8.4"

2. 在您的项目中，运行以下命令：

   sbt update

每次默认分支更新时，你可以创建一个新包。

1. 创建一个 ci_settings.xml 文件，作为 Maven 的 settings.xml 文件。

2. 添加与你在 pom.xml 中定义的相同 ID 的 server 部分。例如，使用 gitlab-maven 作为 ID：

   <settings xmlns="http://maven.apache.org/SETTINGS/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd">
     <servers>
       <server>
         <id>gitlab-maven</id>
         <configuration>
           <httpHeaders>
             <property>
               <name>Job-Token</name>
               <value>${CI_JOB_TOKEN}</value>
             </property>
           </httpHeaders>
         </configuration>
       </server>
     </servers>
   </settings>

3. 确保你的 pom.xml 文件包含以下内容。你可以让 Maven 使用预定义的 CI/CD 变量，如本例所示，或者你可以硬编码服务器的主机名和项目的 ID。

   <repositories>
     <repository>
       <id>gitlab-maven</id>
       <url>${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/maven</url>
     </repository>
   </repositories>
   <distributionManagement>
     <repository>
       <id>gitlab-maven</id>
       <url>${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/maven</url>
     </repository>
     <snapshotRepository>
       <id>gitlab-maven</id>
       <url>${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/maven</url>
     </snapshotRepository>
   </distributionManagement>

4. 向你的 .gitlab-ci.yml 文件添加一个 deploy 任务：

   deploy:
     image: maven:3.6-jdk-11
     script:
       - 'mvn deploy -s ci_settings.xml'
     rules:
       - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH

5. 将这些文件推送到你的仓库。

下次运行 deploy 任务时，它会将 ci_settings.xml 复制到用户的 home 目录。在此示例中：

• 用户是 root，因为任务在 Docker 容器中运行。
• Maven 使用配置好的 CI/CD 变量。

每次默认分支更新时，你可以创建一个包。

1. 通过Gradle 中的 CI 作业令牌进行身份验证。

2. 向你的 .gitlab-ci.yml 文件添加一个 deploy 任务：

   deploy:
     image: gradle:6.5-jdk11
     script:
       - 'gradle publish'
     rules:
       - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH

3. 将文件提交到你的仓库。

当流水线成功时，Maven 包会被创建。

• mvn deploy：将您的包发布到包注册表。
• mvn install：安装Maven项目指定的包。
• mvn dependency:get：安装特定包。

• gradle publish：将您的包发布到包注册表。
• gradle install：安装Gradle项目指定的包。