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

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

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

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

Autolinks with alphanumeric IDs | GitHub Changelog

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

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

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

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

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

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

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

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