MavenとGitHubでライブラリ共有手順
- 2024年11月29日
GitHubでMavenリポジトリを作る方法
Javaプロジェクトで作成したjarライブラリを、どのように共有すればよいか迷ったことはありませんか？この記事では、GitHubにMavenリポジトリを構築し、jarライブラリを簡単に配布する方法を解説します。初心者でもわかりやすい手順で、配布の悩みを解決しましょう！
やってみよう！
📘 GitHubで空のリポジトリを作成し、公開設定を行う
１．GitHubにログインし、「New Repository」ボタンをクリックします。
２．リポジトリ名を入力し、「Public」を選択します。
３．その後、「Create repository」をクリックして空のリポジトリを作成します。
💡 EclipseでSpring Bootプロジェクトを作成し、jarパッケージ管理用に設定する
１．Eclipseを起動し、「File > New > Spring Starter Project」を選択します。
２．必要なプロジェクト名やパッケージ名を設定します。
３．依存関係は最低限の設定で構いません（例: Spring WebやSpring Boot DevTools）。
📝 pom.xmlの設定を行う
作成したプロジェクトのルートにあるpom.xmlを編集し、以下の設定を追加します１．プロジェクト情報（groupId、artifactId、version）を確認して適切に変更します。
２．必要な依存関係を追加します。
３．配布用設定として「distributionManagement」タグを記述します。
<distributionManagement>
<repository>
<id>github</id>
<name>GitHub Packages</name>
<url>https://maven.pkg.github.com/あなたのGitHubユーザー名/リポジトリ名</url>
</repository>
</distributionManagement>
<pluginRepositories>
<pluginRepository>
<id>github</id>
<url>https://maven.pkg.github.com/あなたのGitHubユーザー名/リポジトリ名</url>
</pluginRepository>
</pluginRepositories>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-deploy-plugin</artifactId>
<version>3.1.0</version>
<executions>
<execution>
<goals>
<goal>deploy</goal>
</goals>
<configuration>
<repositoryId>github</repositoryId>
<url>https://maven.pkg.github.com/あなたのGitHubユーザー名/リポジトリ名</url>
</configuration>
</execution>
</executions>
</plugin>
✨ settings.xmlをm2フォルダに配置する
１．mavenの設定ファイルは通常~/.m2/settings.xmlにあります。
２．ファイルが存在しない場合は新規作成し、以下の内容を記載します。
トークン名が分からなければ、Githubの設定画面から発行できます。
<servers>
<server>
<id>github</id> <!– このIDは、pom.xmlで設定したrepositoryIdと一致する必要があります。 –>
<username>あなたのGithubユーザー名</username>
<password>トークン名</password> <!– GitHubで自動生成されたトークンを使用します。 –>
</server>
</servers>
</settings>
トークンの発行方法
🌟 設定済みのソースコードをGitHubにアップロードする
１．Desktop GitHubで設定後のソースをGithubにアップロードします。
📕 公開用のJARファイルをアップロード実施
以下のコマンドで実行してみてください。mvn deploy:deploy-file -Dfile=Jarファイルパス -DgroupId=グループID -DartifactId=アーティファクトID -Dversion=バージョン番号 -Dpackaging=jar -DrepositoryId=github -Durl=https://maven.pkg.github.com/あなたのGithubユーザー名/リポジトリ名
実行が正常に終わったら、「uploaded to …」が表示されます。
🔍 GitHub上での確認
１．GitHubのリポジトリページに移動し、アップロードされたファイルがすべて揃っていることを確認します。
２．リポジトリの「Packages」タブを開き、Mavenパッケージとして認識されているかをチェックします。
✏️ 外部プロジェクトでの使用方法
１．配布したjarライブラリを外部プロジェクトで使用するには、pom.xmlに以下を追加します。
１）：リポジトリ情報：GitHub PackagesのURLを記載。
２）：依存関係情報：公開したライブラリのgroupId、artifactId、versionを記載。
２．Mavenをリフレッシュし、依存関係が正しく追加されていることを確認します。
これで、GitHubを使ったMavenリポジトリの作成と利用が可能になります！
🔍 まとめ
GitHubで、自分が作ったJARファイルを簡単にシェアできちゃいます！まずGitHubでリポジトリを作って、プロジェクトを設定してJARをアップロード。その後、他のプロジェクトでもサクッと使えるようになるので、ライブラリのシェアがめちゃくちゃ簡単になりますよ！