이 기사에서는 Gradle 빌더를 사용하여 Github Actions를 통해 Sonatype Maven Central Repository에 Java 아티팩트를 처음부터 게시하는 프로세스를 자세히 살펴보고자 합니다.

한 곳에 일반적인 튜토리얼이 없기 때문에 이 글을 쓰기로 했습니다. 모든 정보는 완전히 신선하지 않은 다양한 출처에서 하나씩 수집해야했습니다. 누가 신경 쓰나요, 고양이 밑에서 환영합니다.

Sonatype에서 저장소 생성

첫 번째 단계는 Sonatype Maven Central에 저장소를 생성하는 것입니다. 이것을 위해 우리는 간다 여기에, 새 작업을 등록하고 생성하여 리포지토리 생성을 요청합니다. 우리는 우리에서 운전 그룹 ID 프로젝트, 프로젝트 URL 프로젝트 링크 및 SCM URL 프로젝트가 있는 버전 제어 시스템에 대한 링크. 그룹 ID com.example, com.example.domain, com.example.testsupport 형식이어야 하며 github에 대한 링크 형식일 수도 있습니다. github.com/yourusername -> io.github.yourusername. 어쨌든 이 도메인 또는 프로필의 소유권을 확인해야 합니다. github 프로필을 지정한 경우 원하는 이름으로 공개 리포지토리를 생성하라는 메시지가 표시됩니다.

확인 후 일정 시간이 지나면 GroupId가 생성되고 다음 단계인 Gradle 구성으로 넘어갈 수 있습니다.

Gradle 구성

작성 당시에는 아티팩트를 게시하는 데 도움이 될 수 있는 Gradle 플러그인을 찾지 못했습니다. 그것 그러나 내가 찾은 유일한 플러그인은 작성자가 추가 지원을 거부했습니다. 그래서 나는 이것을하는 것이 그리 어렵지 않기 때문에 모든 것을 스스로하기로 결정했습니다.

가장 먼저 파악해야 할 것은 퍼블리싱을 위한 Sonatype의 요구 사항입니다. 다음과 같습니다.

• 소스 코드 및 JavaDoc의 가용성, 즉. 참석해야합니다 -sources.jar и-javadoc.jar 파일. 문서에 명시되어 있듯이 소스코드나 문서를 제공할 수 없는 경우 더미를 만들 수 있습니다. -sources.jar 또는 -javadoc.jar 내부에 간단한 README가 포함되어 있어 테스트를 통과할 수 있습니다.
• 모든 파일은 다음으로 서명해야 합니다. GPG/PGP과 .asc 서명이 포함된 파일은 각 파일에 포함되어야 합니다.
• 가용성 pom 파일
• 올바른 값 groupId, artifactId и version. 버전은 임의의 문자열일 수 있으며 다음으로 끝날 수 없습니다. -SNAPSHOT
• 참석 필요 name, description и url
• 라이센스, 개발자 및 버전 제어 시스템에 대한 정보의 존재

게시할 때 따라야 하는 기본 규칙입니다. 전체 정보 제공 여기에.

우리는 이러한 요구 사항을 build.gradle 파일. 먼저 개발자, 라이선스, 버전 제어 시스템에 대한 모든 필요한 정보를 추가하고 프로젝트의 URL, 이름 및 설명도 설정합니다. 이를 위한 간단한 방법을 작성해 보겠습니다.

def customizePom(pom) {
    pom.withXml {
        def root = asNode()

        root.dependencies.removeAll { dep ->
            dep.scope == "test"
        }

        root.children().last() + {
            resolveStrategy = DELEGATE_FIRST

            description 'Some description of artifact'
            name 'Artifct name'
            url 'https://github.com/login/projectname'
            organization {
                name 'com.github.login'
                url 'https://github.com/login'
            }
            issueManagement {
                system 'GitHub'
                url 'https://github.com/login/projectname/issues'
            }
            licenses {
                license {
                    name 'The Apache License, Version 2.0'
                    url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
                }
            }
            scm {
                url 'https://github.com/login/projectname'
                connection 'scm:https://github.com/login/projectname.git'
                developerConnection 'scm:git://github.com/login/projectname.git'
            }
            developers {
                developer {
                    id 'dev'
                    name 'DevName'
                    email '[email protected]'
                }
            }
        }
    }
}

다음으로 어셈블리가 생성되는 동안 -sources.jar и-javadoc.jar 파일. 이 섹션의 경우 java 다음을 추가해야 합니다.

java {
    withJavadocJar()
    withSourcesJar()
}

GPG/PGP 서명을 설정하는 마지막 요구 사항으로 이동하겠습니다. 이렇게 하려면 플러그인을 연결합니다. signing:

plugins {
    id 'signing'
}

섹션을 추가합니다.

signing {
    sign publishing.publications
}

마지막으로 섹션을 추가하겠습니다. publishing:

publishing {
    publications {
        mavenJava(MavenPublication) {
            customizePom(pom)
            groupId group
            artifactId archivesBaseName
            version version

            from components.java
        }
    }
    repositories {
        maven {
            url "https://oss.sonatype.org/service/local/staging/deploy/maven2"
            credentials {
                username sonatypeUsername
                password sonatypePassword
            }
        }
    }
}

여기에 sonatype사용자 이름 и sonatype암호 에 등록하는 동안 생성된 로그인 및 암호를 포함하는 변수 sonatype.org.

그리하여 결승전 build.gradle 다음과 같이 표시됩니다.

전체 build.gradle 코드

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

java {
    sourceCompatibility = JavaVersion.VERSION_1_8
    targetCompatibility = JavaVersion.VERSION_1_8
    withJavadocJar()
    withSourcesJar()
}

group 'io.github.githublogin'
archivesBaseName = 'projectname'
version = System.getenv('RELEASE_VERSION') ?: "0.0.1"

repositories {
    mavenCentral()
}

dependencies {
    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.5.2'
    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.5.2'
}

test {
    useJUnitPlatform()
}

jar {
    from sourceSets.main.output
    from sourceSets.main.allJava
}

signing {
    sign publishing.publications
}

publishing {
    publications {
        mavenJava(MavenPublication) {
            customizePom(pom)
            groupId group
            artifactId archivesBaseName
            version version

            from components.java
        }
    }
    repositories {
        maven {
            url "https://oss.sonatype.org/service/local/staging/deploy/maven2"
            credentials {
                username sonatypeUsername
                password sonatypePassword
            }
        }
    }
}

def customizePom(pom) {
    pom.withXml {
        def root = asNode()

        root.dependencies.removeAll { dep ->
            dep.scope == "test"
        }

        root.children().last() + {
            resolveStrategy = DELEGATE_FIRST

            description 'Some description of artifact'
            name 'Artifct name'
            url 'https://github.com/login/projectname'
            organization {
                name 'com.github.login'
                url 'https://github.com/githublogin'
            }
            issueManagement {
                system 'GitHub'
                url 'https://github.com/githublogin/projectname/issues'
            }
            licenses {
                license {
                    name 'The Apache License, Version 2.0'
                    url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
                }
            }
            scm {
                url 'https://github.com/githublogin/projectname'
                connection 'scm:https://github.com/githublogin/projectname.git'
                developerConnection 'scm:git://github.com/githublogin/projectname.git'
            }
            developers {
                developer {
                    id 'dev'
                    name 'DevName'
                    email '[email protected]'
                }
            }
        }
    }
}

환경 변수에서 버전을 얻는다는 점에 유의하고 싶습니다. System.getenv('RELEASE_VERSION'). 어셈블리 중에 노출하고 태그 이름에서 가져옵니다.

PGP 키 생성

Sonatype의 요구 사항 중 하나는 모든 파일이 GPG/PGP 키로 서명되어야 한다는 것입니다. 이것을 위해 우리는 간다 여기에 운영 체제용 GnuPG 유틸리티를 다운로드합니다.

• 키 쌍을 생성합니다. gpg --gen-key, 사용자 이름, 이메일을 입력하고 비밀번호도 설정하십시오.
• 알아 내기 id 다음 명령이 포함된 키: gpg --list-secret-keys --keyid-format short. ID는 슬래시 뒤에 지정됩니다(예: rsa2048/9B695056).
• 서버에 공개 키 게시 https://keys.openpgp.org 명령으로: gpg --keyserver [https://keys.openpgp.org](https://keys.openpgp.org/) --send-keys 9B695056
• 비밀 키를 임의의 위치로 내보냅니다. 앞으로 필요할 것입니다. gpg --export-secret-key 9B695056 > D:\gpg\9B695056.gpg

Github 작업 설정

마지막 단계로 이동하여 Github Actions를 사용하여 빌드 및 자동 게시를 설정합니다.
Github Actions는 전체 CI/CD 주기를 구현하여 워크플로를 자동화할 수 있는 기능입니다. 빌드, 테스트 및 배포는 코드 푸시, 릴리스 생성 또는 문제와 같은 다양한 이벤트에 의해 트리거될 수 있습니다. 이 기능은 공용 리포지토리에 대해 완전 무료입니다.

이 섹션에서는 빌드 및 푸시 코드를 설정하고 출시 시 Sonatype 리포지토리에 배포하는 방법과 비밀을 설정하는 방법을 보여드리겠습니다.

우리는 비밀을 설정

자동 조립 및 배포를 위해서는 키 ID, 키 생성 시 입력한 비밀번호, PGP 키 자체, Sonatype 로그인/비밀번호와 같은 여러 비밀 값이 필요합니다. 리포지토리 설정의 특수 섹션에서 설정할 수 있습니다.

다음 변수를 설정합니다.

• SONATYPE_USERNAME / SONATYPE_PASSWORD - Sonatype에 등록할 때 입력한 로그인/비밀번호
• SIGNING_KEYID/SIGNING_PASSWORD — 생성 중에 설정된 PGP 키 ID 및 암호입니다.

GPG_KEY_CONTENTS 변수에 대해 더 자세히 설명하고 싶습니다. 사실 출판을 위해서는 개인 PGP 키가 필요합니다. 비밀글에 올리기 위해, 지시 추가로 여러 조치를 취했습니다.

• gpg로 키를 암호화해 봅시다. gpg --symmetric --cipher-algo AES256 9B695056.gpg비밀번호를 입력하여. SECRET_PASSPHRASE 변수에 배치해야 합니다.
• 받은 암호화 키를 base64를 사용하여 텍스트 형식으로 변환해 보겠습니다. base64 9B695056.gpg.gpg > 9B695056.txt. 콘텐츠는 GPG_KEY_CONTENTS 변수에 배치됩니다.

코드 푸시 및 PR 생성 시 빌드 설정

먼저 프로젝트의 루트에 폴더를 만들어야 합니다. .github/workflows.

예를 들어 파일을 표시하십시오. gradle-ci-build.yml 다음 내용으로:

name: build

on:
  push:
    branches:
      - master
      - dev
      - testing
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - name: Set up JDK 8
        uses: actions/setup-java@v1
        with:
          java-version: 8

      - name: Build with Gradle
        uses: eskatos/gradle-command-action@v1
        with:
          gradle-version: current
          arguments: build -PsonatypeUsername=${{secrets.SONATYPE_USERNAME}} -PsonatypePassword=${{secrets.SONATYPE_PASSWORD}}

이 워크플로는 브랜치로 푸시할 때 실행됩니다. master, dev и testing, 풀 요청을 생성할 때도 마찬가지입니다.

작업 섹션은 지정된 이벤트에서 실행할 단계를 지정합니다. 이 경우 최신 버전의 ubuntu에서 빌드하고 Java 8을 사용하며 Gradle용 플러그인도 사용합니다. eskatos/gradle-command-action@v1최신 버전의 빌더를 사용하여 다음에 지정된 명령을 실행합니다. arguments. 변수 secrets.SONATYPE_USERNAME и secrets.SONATYPE_PASSWORD 이것이 우리가 이전에 물었던 비밀입니다.

빌드 결과는 작업 탭에 반영됩니다.

새 릴리스가 릴리스되면 자동 배포

자동 배포를 위한 별도의 워크플로 파일을 만들어 보겠습니다. gradle-ci-publish.yml:

name: publish

on:
  push:
    tags:
      - 'v*'

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - name: Set up JDK 8
        uses: actions/setup-java@v1
        with:
          java-version: 8

      - name: Prepare to publish
        run: |
          echo '${{secrets.GPG_KEY_CONTENTS}}' | base64 -d > publish_key.gpg
          gpg --quiet --batch --yes --decrypt --passphrase="${{secrets.SECRET_PASSPHRASE}}" 
          --output secret.gpg publish_key.gpg
          echo "::set-env name=RELEASE_VERSION::${GITHUB_REF:11}"

      - name: Publish with Gradle
        uses: eskatos/gradle-command-action@v1
        with:
          gradle-version: current
          arguments: test publish -Psigning.secretKeyRingFile=secret.gpg -Psigning.keyId=${{secrets.SIGNING_KEYID}} -Psigning.password=${{secrets.SIGNING_PASSWORD}} -PsonatypeUsername=${{secrets.SONATYPE_USERNAME}} -PsonatypePassword=${{secrets.SONATYPE_PASSWORD}}

파일은 트리거되는 이벤트를 제외하고는 이전 파일과 거의 동일합니다. 이 경우 이름이 v로 시작하는 태그를 생성하는 이벤트입니다.

배포하기 전에 암호에서 PGP 키를 추출하여 프로젝트의 루트에 배치하고 암호를 해독해야 합니다. 다음으로 특수 환경 변수를 설정해야 합니다. RELEASE_VERSION 우리가 참조하는 gradle.build 파일. 이 모든 것은 섹션에서 수행됩니다. Prepare to publish. GPG_KEY_CONTENTS 변수에서 키를 가져와 gpg 파일로 변환한 다음 파일에 넣어 해독합니다. secret.gpg.

다음으로 특수 변수로 전환합니다. GITHUB_REF, 여기에서 태그를 만들 때 설정한 버전을 가져올 수 있습니다. 이 변수는 이 경우에 관련이 있습니다. refs/tags/v0.0.2 특정 버전을 얻기 위해 처음 11자를 잘라냅니다. 다음으로 게시를 위해 표준 Gradle 명령을 사용합니다. test publish

Sonatype 저장소에서 배포 결과 확인

릴리스가 생성되면 이전 섹션에서 설명한 워크플로가 시작되어야 합니다. 이렇게 하려면 릴리스를 만듭니다.

태그 이름은 v로 시작해야 합니다. 릴리스 게시를 클릭한 후 워크플로가 성공적으로 완료되면 다음으로 이동할 수 있습니다. 소나타 형식의 넥서스 확인하십시오:

아티팩트가 Staging 저장소에 나타났습니다. 열림 상태로 즉시 나타나며 해당 버튼을 눌러 수동으로 닫힘 상태로 전환해야 합니다. 모든 요구 사항이 충족되었는지 확인한 후 아티팩트는 닫기 상태가 되며 더 이상 수정할 수 없습니다. 이 형식에서는 MavenCentral에서 끝납니다. 모든 것이 잘되면 버튼을 누를 수 있습니다 해제, 아티팩트는 Sonatype 저장소에 저장됩니다.

아티팩트가 MavenCentral에 들어가려면 맨 처음에 생성한 작업에서 아티팩트를 요청해야 합니다. 이 작업은 한 번만 수행하면 되므로 처음으로 게시합니다. 이후에는 이것이 필요하지 않으며 모든 것이 자동으로 동기화됩니다. 그들은 저를 위해 동기화를 빠르게 설정했지만 MavenCentral에서 아티팩트를 사용할 수 있게 되기까지 약 5일이 걸렸습니다.

그게 다야, 우리는 MavenCentral에 아티팩트를 게시했습니다.

유용한 링크

• 비슷한 기사, maven을 통해서만 게시
• 준비 저장소 소나타입
• 락스 작업을 생성할 Sonatype
• 예 모든 것이 설정된 저장소

출처 : habr.com