外部リソースを参照する自動リンクの構成

JIRAのIssueやZendeskのチケットなど外部リソースへの自動リンクを追加して、ワークフローをスムーズにすることができます。

この機能を使用できるユーザーについて

自動リンクは、GitHub Pro、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Server を持つリポジトリで使用できます。

リポジトリへの管理者権限があるユーザーは、自動リンク参照を構成して、外部のサードパーティのサービスに issue、pull request、コミットメッセージ、リリース説明をリンクすることができます。

自動リンク参照で、英数字を使えるようになりました。最初に自動リンクが導入されたときは、数字の識別子を使用する外部リソースしか使えませんでした。カスタム自動リンクが英数字や数値の識別子で機能するようになりました。

カスタム自動リンクを定義するには、参照プレフィックスとターゲット URL を指定します。

参照プレフィックスに重複する名前を付けることはできません。たとえば、TICKET や TICK のようなプレフィックスのカスタム自動リンクを 2 つリポジトリに与えることはできません。いずれも文字列 TICKET123a に一致するからです。
ターゲット URL には、リンクされたリソースの参照識別子を表す <num> 変数が含まれます。

この手順では、外部リソースを参照するように自動リンクを構成する方法を示します。たとえば、ユーザーから報告されたチケットを Zendesk で追跡している場合、Issue を修正するために開いた pull request でチケット番号を参照できます。

GitHub で、リポジトリのメインページに移動します。
リポジトリ名の下にある [Settings] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウンメニューを選び、 [設定] をクリックします。
サイドバーの [Integrations] セクションで、 [Autolink references] をクリックします。
ページの右上にある [自動リンク参照の追加] をクリックします。
外部リソースで使われる参照識別子の形式 (英数字または数値) を選びます。
[参照プレフィックス] に短くわかりやすいプレフィックスを入力します。コラボレーターはこのテキストを使い、外部リソースの自動リンクを生成します。
[ターゲット URL] で、作成する外部システムへのリンクの形式を入力します。参照識別子のプレースホルダーとして <num> 変数を使います。
プレビューを見直し、自動リンクと外部参照のいずれも正しいことを確認し、 [自動リンク参照の追加] をクリックしてリンクを定義します。

たとえば、次のように入力します。