 |
概要 | Discourse GitHub は、GitHubへの貢献に基づいてユーザーにバッジを付与できるようにします。また、ユーザーがGitHubのリンクバックとパーマリンクを作成できるようにします。 |
 |
インストールガイド | このプラグインはDiscourseコアにバンドルされています。別途プラグインをインストールする必要はありません。 |
機能
GitHubバッジ
GitHubへの貢献に基づいてユーザーにバッジを付与します。
使用方法:
- 設定 -\u0026gt; プラグインで
github badges enabledを有効にします。 - GitHubアクセストークンを生成し、
github linkback access tokenの設定に貼り付けます。以下の手順を参照してください。 - 貢献をスキャンするGitHubリポジトリのURLを1つ以上、
github badges reposサイト設定に追加します。
バッジカウントの仕組み:
バッジはすべてのリポジトリ間でコミット数をカウントし、ユーザーが複数のリポジトリに貢献した場合、すべてのコミットが合算されて1つの合計数になります。
-
コミッターバッジ:
-
ブロンズ: 1 コミット
-
シルバー: 25 コミット
-
ゴールド: 1000 コミット
-
バッジの進化:* ユーザーが追跡されているリポジトリのいずれかでより多くの貢献を積み重ねると、バッジのティアが自動的に進化します。たとえば、ユーザーがリポジトリAにコミットし、次にリポジトリBにコミットすると、両方の貢献が合算されて、ブロンズからシルバー、そしてゴールドへと進化します。
GitHubリンクバック
GitHubのプルリクエストやコミットから、それについて言及されたDiscourseの投稿へのリンクを作成します。
使用方法:
- 設定 -\u0026gt; プラグインで
github linkback enabledを有効にします。 - GitHubアクセストークンを生成し、
github linkback access tokenの設定に貼り付けます。以下の手順を参照してください。 - 最後に、投稿したいプロジェクトを
github linkback projectsサイト設定に、以下の形式で追加します:username/repositoryで特定のリポジトリusername/*で特定ユーザーのすべてのリポジトリ
GitHubパーマリンク
GitHubの非パーマリンクを パーマリンク に置き換えます。
使用方法:
- 設定 -\u0026gt; プラグインで
github permalinks enabledを有効にします。
設定
GitHubアクセストークン
リンクバック機能を動作させ、ユーザーにバッジを付与するには、GitHubアクセストークンが必要です。トークンはここから生成できます: Sign in to GitHub · GitHub
リンクバック機能には public_repo スコープが必要で、バッジの付与にはスコープは必要ありません（スコープはすべてチェックを外したままにしておいてください）。public_repo スコープはリポジトリへの 書き込みアクセス を付与するため、リポジトリにアクセスしない一時的なGitHubアカウント を作成し、それ専用にトークンを生成することを推奨します。