KPM に対応したプラグインのリポジトリ
GitHub 上のプラグインをかんたんにインストールするための下準備をします。
概要
KPM で GitHub に公開されているプラグインを簡単にインストールするには、いくつかの条件に従ってリポジトリを構築する必要があります。
KPM に対応したリポジトリの条件
リポジトリを KPM に対応させるには、以下の条件を満たす必要があります。
プラグインを1つ以上リリースしている
KPM はプラグインを GitHub のリリースから取得します。そのため、リリースを作成していないリポジトリは KPM に対応していません。
プラグイン制作がキリの良いところであったり、レビューに回す時などにリリースを作成してください。
リリースのタグとプラグインのバージョンが一致している
**リリースのタグとプラグインのバージョンは一致している必要があります(MUST)**。
備考
タグないしはバージョンの v
接頭辞の有無は問いません。
詳しくは以下のドキュメントを参照してください:
リリースにプラグインのアーティファクト(e.g. JAR ファイル)を含める
KPM は、リポジトリのリリースに含まれるプラグインのアーティファクトをダウンロードしてインストールします。 そのため、 KPM に対応させるにはリリースにプラグインのアーティファクトを含める必要があります。
あなたがプラグインの新しいバージョンをリリースするときに、ビルドして生成されたアーティファクトをリリースに含めるだけで完了します!
ヒント
1 つのリリースに複数のアーティファクトを含める場合は、 確実なプラグインのインストールのためにこちらの条件を参考にしてください。