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

repositoriesセクションをbuild.gradleファイルに追加します:

• 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)
          }
      }
  }

次のセクションを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>

GRADLE_USER_HOMEディレクトリで、次の内容のgradle.propertiesファイルを作成します:

gitLabPrivateToken=REPLACE_WITH_YOUR_TOKEN

repositoriesセクションをbuild.gradleに追加します。

• 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)
          }
      }
  }

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で定義したものです。
• <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

プロジェクトのパッケージとレジストリページに移動し、公開されたパッケージを表示します。

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に依存関係を追加します:

   • 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 build

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セクションを追加します。たとえば、IDとしてgitlab-mavenを使用します:

   <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 build: このプロジェクトを組み立ててテストします。