この記事では、Gradle ビルダーを使用して、Github Actions を通じて Java アーティファクトを最初から Sonatype Maven Central Repository に公開するプロセスを詳しく見ていきたいと思います。

通常のチュートリアルが XNUMX か所にないため、この記事を書くことにしました。さらに、すべての情報はさまざまなソースから少しずつ収集する必要があり、まったく新しいものではありませんでした。気にしないでください、猫の下にようこそ。

Sonatype でのリポジトリの作成

最初のステップは、Sonatype Maven Central でリポジトリを作成することです。このために私たちは行きますここで、新しいタスクを登録して作成し、リポジトリを作成するように求めます。私たちは車で運転します グループ ID 計画、 Project URL プロジェクトリンクと SCM URL プロジェクトが存在するバージョン管理システムへのリンク。 グループ ID ここでは、com.example、com.example.domain、com.example.testsupport の形式にする必要がありますが、github へのリンクの形式にすることもできます。 github.com/あなたのユーザー名 -> io.github.あなたのユーザー名。いずれの場合も、このドメインまたはプロファイルの所有権を確認する必要があります。 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 の要件の XNUMX つは、すべてのファイルが 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 で始まる必要があります。 [リリースの公開] をクリックした後、ワークフローが正常に完了した場合は、次の手順に進むことができます。ソナタイプネクサス確かめる：

アーティファクトがステージングリポジトリに表示されました。すぐに「オープン」ステータスが表示されますが、適切なボタンを押して手動で「クローズ」ステータスに移行する必要があります。すべての要件が満たされていることを確認した後、アーティファクトは Close ステータスになり、変更できなくなります。この形式では、最終的に MavenCentral に配置されます。すべて問題なければ、ボタンを押してください リリース、アーティファクトは Sonatype リポジトリに保存されます。

アーティファクトを MavenCentral に取り込むには、最初に作成したタスクでアーティファクトを要求する必要があります。これを行う必要があるのは 5 回だけなので、初めて公開します。次回以降、これは必要ありません。すべてが自動的に同期されます。彼らはすぐに同期を有効にしてくれましたが、アーティファクトが MavenCentral で利用できるようになるまでに約 XNUMX 日かかりました。

これで、アーティファクトを MavenCentral に公開できました。

便利なリンク集

似ている記事、Maven 経由でのみ公開します
上演リポジトリソナタイプ
JIRA タスクを作成する Sonatype
例すべてが設定されたリポジトリ

出所： habr.com

Gradle および Github アクションを使用して Java プロジェクトを Sonatype Maven Central リポジトリに公開する