GitHubリポジトリのリンクからプラグインをインストールできます。プラグインの開発が完了したら、他の人がダウンロードして使用できるように、公開GitHubリポジトリにプラグインを公開することを選択できます。まだプラグインを開発していない場合は、プラグイン開発入門ガイドを参照してください。

この方法には、以下の利点があります。

• 個人管理：プラグインのコードと更新を完全に制御できます • 迅速な共有：GitHubリンクを通じて他のユーザーやチームメンバーに簡単に共有でき、テストと使用に便利です • 協力とフィードバック：プラグインをオープンソースにすると、GitHub上の潜在的な協力者を引き付け、プラグインの迅速な改善に役立つ可能性があります

この記事では、プラグインをGitHubリポジトリに公開する方法を説明します。

​
準備作業

まず、プラグインを開発しテスト済みであること、およびプラグイン開発の基本概念とプラグイン開発者行動規範を読んだことを確認してください。プラグインを公開する前に、ローカルに以下のツールがインストールされていることを確認してください：

  • GitHubアカウント
  • 新しい公開GitHubリポジトリを作成する
  • ローカルにGitツールがインストール済みであること

GitHubの基本知識については、GitHubドキュメントを参照してください。

​
1. プラグインプロジェクトの完成

公開GitHubにアップロードするということは、プラグインを公開することを意味します。プラグインのデバッグと検証が完了し、プラグインの README.md ファイルの説明が完成していることを確認してください。

説明ファイルには、以下の内容を含めることをお勧めします：

  • プラグインの概要と機能説明
  • インストールと設定の手順
  • 使用例
  • 連絡先または貢献ガイドライン

​
2. ローカルプラグインリポジトリの初期化

プラグインをGitHubに公開アップロードする前に、プラグインのデバッグと検証作業が完了していることを確認してください。詳細はリモートデバッグプラグインを参照してください。ターミナルでプラグインプロジェクトフォルダに移動し、以下のコマンドを実行します：

git init
git add .
git commit -m "Initial commit: Add plugin files"

初めてGitを使用する場合、Gitのユーザー名とメールアドレスを設定する必要があるかもしれません：

git config --global user.name "Your Name"
git config --global user.email "your.email@example.com"

​
3. リモートリポジトリへの接続

以下のコマンドを使用して、ローカルリポジトリをGitHubリポジトリに接続します：

git remote add origin https://github.com/<your-username>/<repository-name>.git

​
4. プラグインファイルのアップロード

プラグインをパッケージ化する前に、プラグインのmanifest.yamlファイルと/providerパス以下の.yamlファイル内のauthorフィールドがGitHub IDと一致していることを確認してください。マニフェストファイルの详细な仕様については、マニフェストファイルによるプラグイン情報の定義を参照してください。

プラグインプロジェクトをGitHubリポジトリにプッシュします：

git branch -M main
git push -u origin main

コードをアップロードする際には、後でコードをパッケージ化するためにタグを付けることをお勧めします。

git tag -a v0.0.1 -m "Release version 0.0.1"

git push origin v0.0.1

​
5. プラグインコードのパッケージング

GitHubコードリポジトリのReleasesページに移動し、新しいバージョンリリースを作成します。バージョンをリリースする際には、プラグインファイルをアップロードする必要があります。プラグインファイルのパッケージング方法については、ローカルファイルとしてパッケージ化して共有で詳しく説明しています。

​
GitHub経由でのプラグインインストール

他の人はGitHubリポジトリのアドレスを通じてこのプラグインをインストールできます。Difyプラットフォームのプラグイン管理ページにアクセスし、「GitHub経由でプラグインをインストール」を選択し、リポジトリのアドレスを入力後、バージョン番号とパッケージファイルを選択してインストールを完了します。

​
関連リソース

このページを編集する

直接貢献することでドキュメントの改善にご協力ください

問題を報告する

エラーを見つけたり提案がありますか？お知らせください