github으로 maven repo 만들기

 

 

 

 

사이드 프로젝트를 초기 진행을 해보면서 사용자에게 서비스를 제공하는 방식으로

maven repo 제공 방식을 경험해볼 수 있는 기회가 생겨서 어떻게 구현했는지 기록해보았다! 

 

github을 이용해서 maven repo를 구현해서 사용할 수 있게 제공해보았다. 

 

 

 

 

 

 

mvn-repository-publish

 

maven repo 형식으로 서비스를 제공하기 위해서 mvn-repository-publish를 사용할 수 있다. 

• 공식 문서 : https://docs.github.com/ko/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#authenticating-to-github-packages

Gradle 레지스트리 작업 - GitHub Docs

 

 

 

먼저, 서비스를 제공할 프로젝트 레포와 sdk를 제공할 mvn repo용으로 사용될 프로젝트 레파지토리를 만들어주어야 한다.

여기서는 간단하게 서비스 프로젝트는  test-project, mvn repo용으로 제공된 레포는 test-project-mvn-repo로 지칭한다. 

 

 

mvn repository로 배포하고자 하는 프로젝트의 build.gradle.kts에 다음과 같이 추가한다. 

// 배포하고자 하는 그룹과 버전을 설정 
group = "com.test.project"
version = "0.0.1-SNAPSHOT"

// mavne-publish 플러그인 적용 
apply {
    plugin("maven-publish")
}

// jar 파일 설정 
tasks.jar {
    enabled = true
    archiveClassifier.set("")
    archiveFileName.set("test-project-${project.version}.jar")
}

// publish 옵션 설정
configure<PublishingExtension> {
    publications {
        create<MavenPublication>("mavenJava") {
            artifact(tasks.kotlinSourcesJar.get())
            artifact(tasks.jar.get())
        }
     }

    repositories {
        maven {
	        // sdk 프로젝트를 제공할 github 주소를 입력한다 
            url = uri("https://maven.pkg.github.com/test-project/test-project-mvn-repo")
            credentials {
                username = project.findProperty("repo.user") as String? ?: System.getenv("TEST_PROJECT_REPO_ID")
                password = project.findProperty("repo.key") as String? ?: System.getenv("TEST_PROJECT_REPO_KEY")
            }
        }
    }
}

// sourceSets 설정
tasks.kotlinSourcesJar {
    archiveClassifier.set("sources")
    from(sourceSets.main.get().allSource)
}

 

 

여기서 프로젝트의 REPO_ID와 REPO_KEY를 gradle 설정에 추가하거나 환경변수 설정을 통해 github repo의 env로 함께 등록해준다.

 

• gradle 설정 방법

 

1. https://github.com/settings/tokens 이동
2. Personal access tokens
3. admin:org, repo, write:packages 토큰 발급
4. .gradle/gradle.properties 설정 

$ pwd
/Users/username/
$ mkdir .gradle
$ cd .gradle
$ vi gradle.properties

repo.user={github username}
repo.key={3에서 발급받은 토큰}

 

• 환경변수 설정 방법

 

1. 자신이 사용 중인 셸의 설정 파일(i.e., .zshrc)에 반영

export TEST_PROJECT_REPO_ID={github username}
export TEST_PROJECT_REPO_KEY={3에서 발급받은 토큰}

 

 

 

 

그 이후, 터미널에서 다음의 명령어로 publish 한다. 

 

$ ./gradlew publish 혹은 gradle publish

 

 

 

 

publish가 완성되면 위에서 설정한 mvn repo 에서 배포 내용을 확인할 수 있다. 

여기서는 https://maven.pkg.github.com/test-project/test-project-mvn-repo/packages 에서 내용을 확인할 수 있다. 

 

단, 여기서 항상 버전에 따라서 생성이 되기 때문에, publish 할때마다 버전을 설정해주어야 함에 유의하자. 

 

 

 

 

 

만들어진 mvn repository 사용하기  

 

만들어진 mvn repository는 다음과 같이 사용할 수 있다. 

 

여기서도 REPO_ID와 REPO_KEY를 gradle 설정에 반영하거나 환경 변수 설정을 통해 Github key 설정이 되어있어야 한다. 

   dependencies {
       implementation("com.test.project:test-project:0.0.1-SNAPSHOT")
   }

   repositories {
       maven {
           url = uri("https://maven.pkg.github.com/test-project/test-project-mvn-repo")
           credentials {
               username = project.findProperty("repo.user") as String? ?: System.getenv("TEST_PROJECT_REPO_ID")
               password = project.findProperty("repo.key") as String? ?: System.getenv("TEST_PROJECT_REPO_KEY")
           }
       }
   }

 

 

build를 하면 성공적으로 받아온 mvn repository를 import하여 사용할 수 있는 것을 확인할 수 있다!

 

 

 

 

 

 

 

github workflow로 mvn repository publish 자동화하기 

 

원한다면, github workflow를 통해서 mvn repository에 publish 하는 작업을 자동화 할수도 있다.

• 참고 : https://docs.github.com/en/actions/use-cases-and-examples/publishing-packages/publishing-java-packages-with-maven

단, 이 경우 위에서 설정한 TEST_PROJECT_REPO_ID, TEST_PROJECT_REPO_KEY를 github actions를 통해서 배포시 사용을 위해 organization의 secrets에 설정해야 한다. 

• secrets 생성 안내 : https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions
• organization -> security -> secrets and variables -> new organization secret을 통해 생성 가능 

 

 

name: test-project-mvn-repo Github packages 개발 배포 테스트

on:
  workflow_dispatch:

jobs:
  publish:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      packages: write
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Set up JDK 17
        uses: actions/setup-java@v3
        with:
          java-version: '17'
          distribution: 'temurin'
      - name: Build and Publish
        run: |
          ./gradlew clean build publish
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          TEST_PROJECT_REPO_ID: ${{ secrets.TEST_PROJECT_REPO_ID }}
          TEST_PROJECT_REPO_KEY: ${{ secrets.TEST_PROJECT_REPO_KEY }}

 

 

 

 

 

해당 워크플로우가 돌면, 생성되는것을 확인 가능하다. 

끝 ✨ ✨ ✨ ✨ ✨!!

 

 

 

 

 

 

• 참고 사이트 ✨

https://m.blog.naver.com/PostView.naver?isHttpsRedirect=true&blogId=occidere&logNo=221285584339

Github으로 개인 Maven Repository 만들기

https://bcho.tistory.com/790

maven nexus 설치

https://waspro.tistory.com/509?category=860683

[Spring Boot] Spring Boot Maven Repo 구축(Nexus2 OSS 내부 저장소)

https://waspro.tistory.com/510

[Spring Boot] Spring Boot Maven Repo 연동(Nexus2 OSS 내부 저장소)

https://docs.gradle.org/7.6.1/userguide/publishing_maven.html#publishing_maven:complete_example

Maven Publish Plugin

https://doohee94.tistory.com/32

Maven Central에 JAVA 라이브러리 등록하기

https://mycup.tistory.com/426

gradle nexus repository upload, maven-publish 연동방법

https://github.com/github/maven-plugins

GitHub - github/maven-plugins: Official GitHub Maven Plugins

https://jamcode.tistory.com/38

Github 에 개인 maven repository 생성하기

https://stackoverflow.com/questions/63041402/github-packages-single-maven-repository-for-github-organization

GitHub packages: Single Maven repository for GitHub organization

https://docs.gradle.org/current/userguide/publishing_maven.html

The Maven Publish Plugin

https://docs.github.com/ko/enterprise-cloud@latest/actions/publishing-packages/publishing-java-packages-with-gradle

Gradle을 사용하여 Java 패키지 게시 - GitHub Enterprise Cloud Docs

https://xzio.tistory.com/1644

GitHub - github를 maven repository로 사용하기(깃허브를 메이븐 레포지토리로 사용하기)

https://jha-memo.tistory.com/149

Git 작업시 personal access token 에러

https://docs.github.com/en/actions/publishing-packages/publishing-java-packages-with-maven

Publishing Java packages with Maven - GitHub Docs

https://docs.github.com/ko/packages/quickstart

GitHub Packages 빠른 시작 - GitHub Docs

https://docs.github.com/ko/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#authenticating-to-github-packages

Gradle 레지스트리 작업 - GitHub Docs

https://docs.github.com/ko/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#github-actions%EB%A5%BC-%EC%82%AC%EC%9A%A9%ED%95%9C-github-packages-%EC%A0%95%EB%B3%B4

GitHub Actions를 사용하여 패키지 게시 및 설치 - GitHub Docs

https://docs.github.com/ko/enterprise-cloud@latest/actions/publishing-packages/publishing-