パッケージレジストリ内の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)
           }
       }
   }
  

SBTの認証は基本HTTP認証に基づいています。名前とパスワードを入力する必要があります。

sbt を使用して Maven GitLab パッケージレジストリからパッケージをインストールするには、Maven リゾルバを設定する必要があります。非公開または内部のプロジェクトやグループにアクセスする場合は、認証情報を設定する必要があります。リゾルバと認証の設定後、プロジェクト、グループ、またはネームスペースからパッケージをインストールできます。

build.sbt に以下の行を追加します：

resolvers += ("gitlab" at "<endpoint url>")

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

この例では:

• <endpoint url> はエンドポイントURLです。例:https://gitlab.example.com/api/v4/projects/<project_id>/packages/maven.
• <host> はプロトコルスキームやポートを除いた<endpoint url> 内のホストです。例:gitlab.example.com.
• <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](#edit-the-client-configuration)で定義した[です。
• <your_endpoint_url> はどのエンドポイントを選ぶかによって異なります。
• gitlab.example.com をドメイン名に置き換えてください。

Gradle を使ってパッケージを公開するには、次のようにします：

1. Gradleプラグインmaven-publish をプラグインセクションに追加します：

   • 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 // the variable resides in $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? // the variable resides in $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ページに移動し、パブリッシュされたパッケージを表示します。

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

Mavendependency: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 への依存関係を追加してください：

   • 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. Maven のsettings.xml ファイルとして機能するci_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 をユーザーのホームにコピーします。この例では

• ジョブはDockerコンテナで実行されるため、ユーザーはroot 。
• 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プロジェクトで指定したパッケージをインストールします。