Maven 패키지 레지스트리의 Maven 패키지

참고:
<name> 필드는 선택한 토큰에 맞게 명명해야 합니다.

다음 섹션을 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>  

참고:
<name> 필드는 선택한 토큰에 맞게 명명해야 합니다.

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

다음 섹션을 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

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

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 // 변수는 $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

publish 작업을 실행합니다:

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 파일의 경로입니다.

참고:

명령(gitlab-maven)과 settings.xml 파일의 리포지토리 ID가 일치해야 합니다.

메시지는 패키지가 패키지 레지스트리에서 다운로드되고 있음을 보여야 합니다:

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 섹션을 추가합니다. 예를 들어, 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 파일에 다음 사항이 포함되어 있는지 확인합니다. 기본 CI/CD 변수를 사용하도록 Maven을 설정할 수 있으며, 이 예제처럼 구성할 수 있습니다. 또는 서버의 호스트 이름과 프로젝트 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이 사용자의 홈 위치로 복사됩니다. 이 예제에서:

• 사용자는 ‘root’이며, 작업은 Docker 컨테이너에서 실행됩니다.
• Maven은 구성된 CI/CD 변수를 사용합니다.

기본 브랜치가 업데이트될 때마다 패키지를 생성할 수 있습니다.

1. CI 작업 토큰으로 Gradle 인증합니다.

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 프로젝트에 지정된 패키지를 설치합니다.