Skip to main content

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

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

自動リンクは、GitHub Pro、GitHub Team、GitHub Enterprise Cloud,、GitHub Enterprise Server のリポジトリ内で利用できます。 詳細については、「GitHub's products」を参照してください。

自動リンクについて

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

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

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

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

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

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

  1. GitHub.com で、リポジトリのメイン ページへ移動します。 1. リポジトリ名の下の [ 設定] をクリックします。 リポジトリの設定ボタン

  2. サイドバーの [統合] セクションで、 [自動リンク参照] をクリックします。

  3. [自動リンク参照の追加] をクリックします。 自動リンク参照の情報を入力するボタン。

  4. 外部リソースで使われる参照識別子の形式 (英数字または数値) を選びます。 自動リンク形式の設定、英数字または数値。

  5. [Reference prefix] に、コラボレータ が外部リソースへの自動リンクを生成する際に使用する短くわかりやすいプレフィックスを入力します。 外部システムの省略形を入力するフィールド。

  6. [Target URL] に、リンク先の外部システムへのリンクを入力します。 参照識別子のプレースホルダーとして <num> 変数を使います。 外部システムの URL を入力するフィールド。

  7. [自動リンク参照の追加] をクリックします。