自作の JVMライブラリをJitPackで簡単に公開する方法

はじめに

JVMライブラリの開発者にとって、JitPackはプロジェクトの公開を簡単かつ迅速に行うための重要なツールです。この記事では、Mavenを用いてJitPackでライブラリを効率的に公開する具体的な手順を紹介します。

JitPackってなに？

JitPackは、GitHubなどのGitリポジトリから直接JVMやAndroidライブラリをビルドし、公開できるサービスです。このサービスを利用することで、ライブラリを世界中の開発者に簡単に提供することが可能となります。

JitPackを使ってJVMライブラリを公開してみる

JitPackでライブラリを公開するためには、いくつかの重要な手順を踏む必要があります。

手順1: JitPack Mavenリポジトリの追加

プロジェクトのpom.xmlにJitPackのリポジトリを追加し、JitPackを通じたビルドとアクセスが可能になるように設定します。

pom.xml

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

プロジェクトのソースコード管理（SCM）設定もpom.xmlに追加します。以下は、GitHubリポジトリの仮のURLと接続情報の例です。

pom.xml

<scm>
    <url>https://github.com/exampleuser/exampleproject</url>
    <connection>scm:git:[e-mail]:exampleuser/exampleproject.git</connection>
    <tag>HEAD</tag>
</scm>

これらの設定は、JitPackがプロジェクトのソースコードを適切に取得し、ビルドプロセスを実行するために必要です。

手順2: プラグインの追加

ビルドとリリースのプロセスを管理するため、maven-compiler-pluginとmaven-release-pluginをpom.xmlに追加します。これにより、プロジェクトのビルドとリリースがスムーズに行われます。

pom.xml

<plugin>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.8.1</version>
    <configuration>
        <source>11</source>
        <target>11</target>
    </configuration>
</plugin>
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-release-plugin</artifactId>
    <version>3.0.1</version>
    <configuration>
        <!-- リリースバージョンの指定 -->
        <tagNameFormat>v@{project.version}</tagNameFormat>
        <autoVersionSubmodules>true</autoVersionSubmodules>
        <releaseProfiles>release</releaseProfiles>
        <goals>deploy</goals>
        <!-- SCMコメントの設定 -->
        <scmCommentPrefix>[Release]</scmCommentPrefix>
        <!-- スナップショットバージョンの自動インクリメント -->
        <preparationGoals>clean verify</preparationGoals>
    </configuration>
</plugin>

手順3: インストールの確認

プロジェクトのビルドが正しく行われるかをローカル環境で確認するために、mvn clean installコマンドを実行します。これにより、ライブラリのビルドとインストールが正常に完了するかをテストし、動作が正常であることを確認できます。このステップは、公開前の最終確認として非常に重要です。

手順4: GitHubでリリース作成

まず、ターミナルまたはコマンドプロンプトでmvn release:prepareコマンドを実行し、リリース準備を行います。このコマンドは、バージョン番号の更新、タグの作成、そしてリリース用のコミットを自動的に生成します。

その後、GitHubのリポジトリ画面に移動し、生成されたタグに基づいてリリースを作成します。タイトル、説明を入力し、リリースを公開すると、JitPackはこの新しいリリースを検出し、ライブラリとしてビルドを開始します。GitHubでのリリース作成は、JitPackによるビルドプロセスのトリガーとなり、プロジェクトがJitPack上で利用可能になります。

GitHubを確認してみると、新しいタグが作成されていることが確認できます。

そのまま、Releases画面を開いて、タイトルと説明を入力して、リリースを公開します。

リリースの作成が完了したら、JitPackへアクセスして、リポジトリのURLを入力して検索を行います。

ビルドが成功すると、Logのアイコンが緑色になります。

公開されたライブラリの使用方法

公開されたライブラリは、他のプロジェクトのpom.xmlに依存関係として追加することで利用可能になります。これにより、他の開発者が簡単にライブラリをプロジェクトに組み込めるようになります。

pom.xml

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>
<dependency>
    <groupId>com.github.cotogoto</groupId>
    <artifactId>noby-java-client</artifactId>
    <version>VERSION</version>
</dependency>

おまけ

公開プロセス中に遭遇する可能性のある問題や、それらの対処方法についても触れます。これには、ビルドエラーの解決や、JitPackとの連携に関する一般的なヒントが含まれます。

その1: SNAPSHOTの付け忘れ　　

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-release-plugin:3.0.1:prepare (default-cli) on project noby-java-client: You don't have a SNAPSHOT project in the reactor projects list. -> [Help 1]

エラー解決のための簡潔な手順は次の通りです：Mavenのrelease:prepareコマンドのエラーは、通常、プロジェクトがSNAPSHOTバージョンでない場合に発生します。pom.xmlでバージョンがSNAPSHOTであることを確認し、必要に応じてSNAPSHOTバージョンに更新します。変更をコミットし、プッシュした後、再度コマンドを実行してみてください。解決しない場合は、Mavenのデバッグオプションを使用して詳細情報を取得し、公式ドキュメントやフォーラムを参照してください。

その2: コミット忘れ　　

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-release-plugin:3.0.1:prepare (default-cli) on project jsonrpc2client: Cannot prepare the release because you have local modifications :        
[ERROR] [pom.xml:modified]
[ERROR]
[ERROR] -> [Help 1] 

このエラーは、Mavenのrelease:prepareコマンド実行時にローカルで未コミットの変更があることを示しています。対処法としては、まずgit statusで変更されたファイルを確認し、意図した変更であればgit addとgit commitコマンドで変更をコミットします。その後、再度mvn release:prepareを実行することで、リリースプロセスを進めることができます。未コミットの変更がある場合、Mavenのリリースプロセスは正常に進行しませんので、変更の管理とコミットが重要です。

まとめ

JitPackを利用すれば、JVMライブラリの公開がより簡単かつ効率的になります。このガイドが、ライブラリ公開のプロセスをスムーズに進める手助けとなることを願います。

参考にした記事