Files
dify-docs/plugin-dev-ja/0322-release-to-individual-github-repo.mdx
2025-07-16 16:42:34 +08:00

118 lines
7.3 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
dimensions:
type:
primary: operational
detail: deployment
level: intermediate
standard_title: Release to Individual GitHub Repo
language: ja
title: 個人のGitHubリポジトリへの公開
description: このドキュメントでは、Difyプラグインを個人のGitHubリポジトリに公開する方法について詳しく説明します。準備作業、ローカルプラグインリポジトリの初期化、リモートリポジトリへの接続、プラグインファイルのアップロード、プラグインコードのパッケージング、GitHub経由でのプラグインインストール方法の全プロセスが含まれます。この方法により、開発者は自身のプラグインコードと更新を完全に管理できます。
---
GitHubリポジトリのリンクからプラグインをインストールできます。プラグインの開発が完了したら、他の人がダウンロードして使用できるように、公開GitHubリポジトリにプラグインを公開することを選択できます。まだプラグインを開発していない場合は、[プラグイン開発入門ガイド](/plugin-dev-ja/0211-getting-started-dify-tool)を参照してください。
この方法には、以下の利点があります。
• **個人管理**:プラグインのコードと更新を完全に制御できます
• **迅速な共有**GitHubリンクを通じて他のユーザーやチームメンバーに簡単に共有でき、テストと使用に便利です
• **協力とフィードバック**プラグインをオープンソースにすると、GitHub上の潜在的な協力者を引き付け、プラグインの迅速な改善に役立つ可能性があります
この記事では、プラグインをGitHubリポジトリに公開する方法を説明します。
### 準備作業
まず、プラグインを開発しテスト済みであること、および[プラグイン開発の基本概念](/plugin-dev-ja/0111-getting-started-dify-plugin)と[プラグイン開発者行動規範](/plugin-dev-ja/0312-contributor-covenant-code-of-conduct)を読んだことを確認してください。プラグインを公開する前に、ローカルに以下のツールがインストールされていることを確認してください:
* GitHubアカウント
* 新しい公開GitHubリポジトリを作成する
* ローカルにGitツールがインストール済みであること
GitHubの基本知識については、[GitHubドキュメント](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository)を参照してください。
### 1. プラグインプロジェクトの完成
公開GitHubにアップロードするということは、プラグインを公開することを意味します。プラグインのデバッグと検証が完了し、プラグインの `README.md` ファイルの説明が完成していることを確認してください。
説明ファイルには、以下の内容を含めることをお勧めします:
* プラグインの概要と機能説明
* インストールと設定の手順
* 使用例
* 連絡先または貢献ガイドライン
### 2. ローカルプラグインリポジトリの初期化
プラグインをGitHubに公開アップロードする前に、プラグインのデバッグと検証作業が完了していることを確認してください。詳細は[リモートデバッグプラグイン](/plugin-dev-ja/0411-remote-debug-a-plugin)を参照してください。ターミナルでプラグインプロジェクトフォルダに移動し、以下のコマンドを実行します:
```bash
git init
git add .
git commit -m "Initial commit: Add plugin files"
```
初めてGitを使用する場合、Gitのユーザー名とメールアドレスを設定する必要があるかもしれません
```bash
git config --global user.name "Your Name"
git config --global user.email "your.email@example.com"
```
### 3. リモートリポジトリへの接続
以下のコマンドを使用して、ローカルリポジトリをGitHubリポジトリに接続します
```bash
git remote add origin https://github.com/<your-username>/<repository-name>.git
```
### 4. プラグインファイルのアップロード
> プラグインをパッケージ化する前に、プラグインの`manifest.yaml`ファイルと`/provider`パス以下の`.yaml`ファイル内のauthorフィールドがGitHub IDと一致していることを確認してください。マニフェストファイルの详细な仕様については、[マニフェストファイルによるプラグイン情報の定義](/plugin-dev-ja/0411-plugin-info-by-manifest)を参照してください。
プラグインプロジェクトをGitHubリポジトリにプッシュします
```bash
git branch -M main
git push -u origin main
```
コードをアップロードする際には、後でコードをパッケージ化するためにタグを付けることをお勧めします。
```bash
git tag -a v0.0.1 -m "Release version 0.0.1"
git push origin v0.0.1
```
### 5. プラグインコードのパッケージング
GitHubコードリポジトリのReleasesページに移動し、新しいバージョンリリースを作成します。バージョンをリリースする際には、プラグインファイルをアップロードする必要があります。プラグインファイルのパッケージング方法については、[ローカルファイルとしてパッケージ化して共有](/plugin-dev-ja/0322-release-by-file)で詳しく説明しています。
![プラグインのパッケージング](https://assets-docs.dify.ai/2024/12/5cb4696348cc6903e380287fce8f529d.png)
### GitHub経由でのプラグインインストール
他の人はGitHubリポジトリのアドレスを通じてこのプラグインをインストールできます。Difyプラットフォームのプラグイン管理ページにアクセスし、「GitHub経由でプラグインをインストール」を選択し、リポジトリのアドレスを入力後、バージョン番号とパッケージファイルを選択してインストールを完了します。
![](https://assets-docs.dify.ai/2024/12/3c2612349c67e6898a1f33a7cc320468.png)
## 関連リソース
- [プラグインの公開](/plugin-dev-ja/0321-release-overview) - さまざまな公開方法を理解する
- [ローカルファイルとしてパッケージ化して共有](/plugin-dev-ja/0322-release-by-file) - プラグインのパッケージング方法
- [マニフェストファイルによるプラグイン情報の定義](/plugin-dev-ja/0411-plugin-info-by-manifest) - プラグインのメタデータを定義する
- [プラグイン開発者行動規範](/plugin-dev-ja/0312-contributor-covenant-code-of-conduct) - プラグイン開発の規範を理解する
- [リモートデバッグプラグイン](/plugin-dev-ja/0411-remote-debug-a-plugin) - プラグインのデバッグ方法を学ぶ
{/*
Contributing Section
DO NOT edit this section!
It will be automatically generated by the script.
*/}
---
[このページを編集する](https://github.com/langgenius/dify-docs/edit/main/plugin-dev-ja/0322-release-to-individual-github-repo.mdx) | [問題を報告する](https://github.com/langgenius/dify-docs/issues/new?template=docs.yml)