2020年のMavenリポジトリの作り方

はじめに

Javaのエンジニアであれば何だかんだでMavenリポジトリを使うことは非常に多いと思います。Gradleであっても使いますしね。

OSSなどはセントラルリポジトリから落とすとして自作のライブラリの管理をどうしていますか？ ローカルだけで開発していればmvn installで事足りますが、CI/CDを行っていたりチームや組織でライブラリを共有している場合はそうもいきません。

という分けで今回はMavenで作成したライブラリを公開するための方法に関してまとめました。ちなみに2020年8月時点でのおすすめはGCSをリポジトリにする方法です。

• Maven Central Repositoryに登録
• OSSのリポジトリサーバを立てる
• GitHub Pagesを使う
• GitHub Packages + Actions を使う
• S3/GCS/Azure Blobにリポジトリを構築する
• GCP Artifact Registry

Maven Central Repositoryに登録

もっとも正攻法の手順となります。登録手続きはややめんどくさいですが、利用時にリポジトリの追加作業が無いのは大きなメリットですね。OSSのライブラリとして利用者を広げたい時には使うと良いと思います。

• OSSRH Guide
• Maven Central Repository に公開手順

OSSのリポジトリサーバを立てる

次に考えられるのがOSSのリポジトリサーバを立てる事です。社内リポジトリとしてはこれが一般的かもしれません。
Nexus Repository ManagerやJFrog artifactoryが有名です。突貫で作る場合ならばJenkinsなどのCIサーバの.m2リポジトリをApache等で公開してしまうという方法もあります。細やかな管理は出来ませんが動くは動くので最低限の機能で手早く作りたい時は選択肢ですね。

GitHub Pagesを使う

GitHubに静的コンテンツをホスティングできる「Github Pages」を活用する方法があります。一昔前に流行りましたね。
基本的な考え方としてはmvn deployでいったんローカルにライブラリをデプロイして、mvn siteでGithub上にPushします。セキュリティ/可用性をGitHubに任せる事が出来るのでかなり便利です。

詳しい手順は以下サイトで詳しく解説されています。

• [小ネタ] GitHub Pagesを使ってMavenの簡易的なリポジトリを作ってみた

個人で作ってるライブラリをPublicに公開するのに便利な方法です。無料ですし。

GitHub Packages + Actions を使う

GitHub PagesをMavenリポジトリとして利用するのはややハック的な所がありますが、最近GitHub Packagesとして正式な方法としてmaven libaryを公開できるようになりました。

• GitHub Packagesで利用するために Apache Maven を設定する

まずはpom.xmlに以下のようにデプロイ先を登録します。

pom.xml

    <distributionManagement>
        <repository>
            <id>github</id>
            <name>GitHub OWNER Apache Maven Packages</name>
            <url>https://maven.pkg.github.com/{YOUR_NAME}/{YOUR_PRJ_NAME}</url>
        </repository>
    </distributionManagement>

手動でやることもできますが秘密鍵を管理するのも面倒なのでActionsを使います。

.github/workflows/maven-publish.yml

name: Publish jl2-web library
on: [ workflow_dispatch ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Set up JDK 11
      uses: actions/setup-java@v1
      with:
        java-version: 11
        server-id: github # Value of the distributionManagement/repository/id field of the pom.xml
        settings-path: ${{ github.workspace }} # location for the settings.xml file
    - name: Build with Maven
      run: mvn -B package --file jl2-web/pom.xml
    - name: Publish to GitHub Packages Apache Maven
      run: mvn deploy -s $GITHUB_WORKSPACE/settings.xml --file jl2-web/pom.xml
      env:
        GITHUB_TOKEN: ${{ github.token }}

このYAMLをベースにGitHub ActionsでCI/CDが動作します。GITHUB_TOKENを使うのであれば特別settings.xmlを管理する必要はないと思われます。

すると以下のようにGitHubリポジトリからリンクが作成されます。

こちらにデプロイしたライブラリを利用する時は以下のpom.xmlのように依存リポジトリを追加します。

pom.xml

    <repositories>
        <repository>
            <id>github</id>
            <name>NKLab repository</name>
            <url>https://maven.pkg.github.com/{YOUR_NAME}/{YOUR_PRJ_NAME}</url>
        </repository>
    </repositories>

GitHub Actionsと組み合わせて非常に便利なんですが以下の課題があります。

• a) パスワード無しでの公開設定のやり方が分からなかった
• b) 複数のライブラリを一つのリポジトリに入れる時の権限管理

課題というか単にやり方が分からないだけなのですが、aは何となく現時点ではサポートしてないように見えます。bに関してはPersonal access token等を使えば出来るのは分かるのですがGITHUB_TOKENでのやり方が分からずちょっとペンディング。

GitHub Actionsとインテグレーションされているのは便利ですし認証必須なことも社内ライブラリであれば問題ないので、GitHubを使ってチーム開発している時にはとても便利だと思います。
なお、有料プランと無料プランが選べます。

Maven Pluginと連携させてGCSにリポジトリを構築する

S3やGCS、Azure Blobのようなオブジェクトストレージに構築する方法です。

• CloudStorageMaven
• Maven RepositoryをGCSに構築する

完全無料ではありませんがオブジェクトストレージは各社とも十分に安いですしMavenのアカウント管理ではなく各クラウドのIAMで権限管理が出来るので既に使っている人には便利だと思います。
私はGCPを使っていますし、CloudBuildも使ってるのでこれが一番楽ですね。

使い方は簡単でpom.xmlに以下のようにプラグインというかextentionの設定をします。最新は2.3ですがGCS対応にバグがあるので1.7の使用をお勧めします。

<distributionManagement>
    <snapshotRepository>
        <id>nklab-snapshot</id>
        <url>gs://{バケット名}/snapshot</url>
    </snapshotRepository>
</distributionManagement>
<build>
    <extensions>
        <extension>
            <groupId>com.gkatzioura.maven.cloud</groupId>
            <artifactId>google-storage-wagon</artifactId>
            <version>1.7</version>
        </extension>
    </extensions>
</build>

urlには任意のバケット名とフォルダ名を記載します。とりあえず私はSnapshotRepositoryにはsnapshotの名前を付けています。repositoryタグを追加する事でもちろんSnapShot以外もデプロイする事ができます。

<distributionManagement>
    <snapshotRepository>
        <id>my-repo-bucket-snapshot</id>
        <url>gs://mavenrepository/snapshot</url>
    </snapshotRepository>
    <repository>
        <id>my-repo-bucket-release</id>
        <url>gs://mavenrepository/release</url>
    </repository>
</distributionManagement>

そして、以下のコマンドでデプロイします。

mvn -B deploy 

この際、権限管理はIAMになるのでGCSにローカルからデプロイしたい場合は以下のようにサービスアカウントの鍵ファイルを環境変数に指定する必要はあります。まあ、GCPではお馴染みの方法ですね。gcloud auth login –briefでログインしての認証でも大丈夫です。

GOOGLE_APPLICATION_CREDENTIALS=~/seacret/mybuild-1632c221dd5c.json mvn -B deploy

利用する場合は以下のようにpom.xml依存に追加します。

<repositories>
    <repository>
        <id>my-repos</id>
        <name>My repository</name>
        <url>https://storage.googleapis.com/{バケット名}/snapshot/</url>
    </repository>
</repositories>

CloudBuildなどからビルドする場合はGCS側の設定さえしておけば特に問題はありません。公開設定も含めてGCSの通常の制御と一緒なのでGCPに慣れている人はこの方法が便利だと思います。

GCP Artifact Registry

GoogleのContainer Registryの後継というか発展版になるサービスです。元々はDocker Containerにしか対応してないのですが、現在α版としてMavenやnodejsも対応しています。

こちら、バックエンドがGCSなのですがセキュリティスキャンの自動化など様々な機能も付いていて、個人的に注目しているサービスとなります。私はGCPがメインプラットフォームなのでCloudBuildなど各システムとの相性も良さそうですし。

ただ、こちらは2020/08時点ではα版なので申請しないと利用できません。とりあえず申請してみたのですがまだ試せてない状態です。秋から年末にかけてβとして一般のユーザも利用できるようになる気がします。

まとめ

Mavenのリポジトリのホスティングは面倒なので地味に悩ましい問題なのですが、最近はOSSを自分でホスティングする以外にも結構選択肢があります。CI/CDを実現するパーツとしても重要なので、この辺をうまく活用して手軽に社内ライブラリや個人ライブラリを共有/公開できるようにしていきたいですね。

それではHappy Hacking!