GitHub の外部サービス自動リンク参照で英数字の識別子が利用可能に

| 2 min read
Author: masahiro-kondo masahiro-kondoの画像

GitHub の Pro/Team/Enterprise のアカウントでは、外部サービスへの自動リンク参照が利用できます。

Jira や Zendesk などの GitHub 以外のサービスで課題やインシデントを管理しているいるプロジェクトも多いでしょう。その場合、GitHub の issue、PR、コミットコメントに JIRA#1 のように プレフィクス<ID> の形式で書くと自動でリンクしてくれる機能です。課題やインシデントを追跡する上で役立ちます。

7月に自動リンク参照で英数字による識別子がサポートされました。

Autolinks with alphanumeric IDs | GitHub Changelog

これにより、リンク先サービスのチケット ID 体系が英数字の場合にも対応できます。

Information

7月時点では、自動リンクを新規作成するときに、英数字の識別子しか選べなかったのですが、顧客のフィードバックを受けて、現在は英数字と数字のみを選択できるようになっています。

Autolinks with alphanumeric or numeric IDs | GitHub Changelog

自動リンク参照を追加するには、リポジトリ設定の Autolink references タブで Add autolink reference をクリックします。

自動リンク設定追加ボタン

自動リンク参照の設定追加画面です。参照先のサービスの採番体系が AlphanumericNumeric かを選択します。Jira の場合、<プロジェクトID>-<番号> の体系なので Alphanumeric を選択。自動リンクを発動させる Reference prefix は、JIRA- にしました。Target URL には、Jira のチケットの URL を <num> というテンプレートを入れて指定します。

Jiraへのリンクを追加

Add autlink reference をクリックすると自動リンク参照が追加されます。

追加されたリンク参照

自動リンク参照設定を行なったリポジトリで、issue の作成画面を開き、JIRA-<ID> の形式で書きます。

issueの編集

プレビューすると、リンクになっています。

issueのプレビュー

リンクを踏むとあらかじめ登録していた Jira のタスクが開きました[1]

参照先のJiraのタスク

以上のように、GitHub 以外のサービスを使って、ストーリー・タスク・インシデントなどを管理している場合、そのサービスの採番体系に合わせた自動リンク参照の設定が可能なため、URL をフルで貼る必要がなくなります。


  1. GitHub と Jira をシステム的にリンクしているわけではないので、この GitHub issue を更新しても、Jira のチケットには何も影響しません。 ↩︎

豆蔵デベロッパーサイト - 先週のアクセスランキング
  1. 基本から理解するJWTとJWT認証の仕組み (2022-12-08)
  2. Docker+Wasm で WASM をコンテナとして実行する (2023-01-25)
  3. 自然言語処理初心者が「GPT2-japanese」で遊んでみた (2022-07-08)
  4. 直感が理性に大反抗!「モンティ・ホール問題」 (2022-07-04)
  5. Nuxt3入門(第4回) - Nuxtのルーティングを理解する (2022-10-09)
  6. AWS認定資格を12個すべて取得したので勉強したことなどをまとめます (2022-12-12)
  7. Jest再入門 - 関数・モジュールモック編 (2022-07-03)
  8. ORマッパーのTypeORMをTypeScriptで使う (2022-07-27)
  9. Nuxt3入門(第8回) - Nuxt3のuseStateでコンポーネント間で状態を共有する (2022-10-28)
  10. Nuxt3入門(第1回) - Nuxtがサポートするレンダリングモードを理解する (2022-09-25)