【Android】GitHubのPrivateなMavenリポジトリを利用する方法を解説

Mavenリポジトリの作成

Mavenリポジトリの作成方法に関しましては、以下の記事にまとめておりますので、そちらを参照していただければと思います。

【Android】GitHubにMavenのリポジトリを作成する方法を解説

Androidのアプリ開発においてライブラリを使用する際、GitHub上にMavenリポジトリを作成し、ライブラリを公開しておくことで、スムーズなライブラリの導入を実現することができます。本記事では、GitHubにMavenリポジトリを作成する方法と、Mavenリポジトリのライブラリを使用する方法について解説致します。

なお上記の記事では、MavenSampleというPublicのリポジトリに、mylibraryというライブラリを公開しました。本記事では、このMavenSampleリポジトリがPrivateであると仮定し、mylibraryを利用するまでを解説していきます。

GitHubのPrivateなMavenリポジトリの利用

Personal access tokenの生成

PrivateなMavenリポジトリを利用するには、認証が必要となります。認証は、Personal access tokenを使用します。

Personal access tokenの生成は、こちらから行います。アクセスしたら、画面右上のGenerate new tokenをクリックします。

続いて、Noteに任意の名前を入力し、repoにチェックを入れたら、画面下部のGenerate tokenをクリックします。

これでTokenが生成されます。Tokenは後々使用しますので、控えておきましょう。

Mavenリポジトリへの認証

ここからは、ライブラリを利用する側のアプリを実装していきます。新規でプロジェクトを作成します(既存のプロジェクトでも構いません)。

続いて、ルートディレクトリにgithub.propertiesを作成し、usernameとtokenを定義します。

続いて、ルートディレクトリ直下のbuild.gradleに以下を追加します。

13、14行目で、github.propertiesに定義したユーザー名とトークンを使用し、認証を行います。

ライブラリの導入

最後に、ライブラリの導入を行います。

app直下のbuild.gradleにmylibraryをimplementationします。

これで、mylibraryが使用できるようになります。
以上、PrivateなMavenリポジトリの利用方法でした。