はじめに
所属している開発チームでは、タスク管理にBacklogを、ソースコードの管理にGitHubを使っています。コミットメッセージ・ブランチ名・プルリクにBacklogの課題キーを入れて、コード変更とタスクとを関連付けています。
しかしタスク内容を確認するためには、毎回Backlogを開いてGitHubに書かれた課題キーで検索する必要があり、手間でした。
タスク確認を楽にするため、AutoLink機能を導入し、GitHubからBacklogの課題を参照できるようにしました。
AutoLinkとは
GitHubのAutoLink機能は、コミットメッセージ・ブランチ名・プルリクに特定の文字列が含まれている場合に、その文字列に対して自動的にリンクを生成する機能です。この機能を使って、Backlogの課題キー (PROJECT-000) に自動的にリンクを付け、GitHub上から直接Backlogの課題ページへアクセスできるようにしました。
GitHubのプランによっては使用することができません。
詳細は参考に記載したGitHub公式ページをご確認ください。
設定方法
1. GitHubリポジトリの設定にアクセス
設定を行いたいリポジトリにアクセスし、上部メニューの「Settings」をクリック
2. AutoLinkの設定へ移動
左のメニュー最下部にある「Autolink references」をクリック
3. 「Add autolink reference」をクリック
4. Autolinkのパラメータ入力
Autolinkの設定画面
- Refrenceprefix
リンクとして設定したい文字列(Backlogの場合は課題キー)
e.g.) PROJECT- - Target URL
GitHubから飛びたいリンク先のURL
e.g.) Backlogの場合：
https://hoge.backlog.com/view/PROJECT-<num>
<num>にはPrefixで設定した文字列より後ろの値が自動的に代入され、URLが作成される仕組みです。
代入される値は、「Alphanumeric」なら英数字すべて、「Numeric」なら数字だけになります。
e.g.) ブランチ名：PROJECT-777-developの時作成されるリンク
Alphanumeric:
https://hoge.backlog.com/view/PROJECT-777-deveplop
Numeric:
https://hoge.backlog.com/view/PROJECT-777
最後に「Add autolink reference」をクリックして設定を反映させます。
反映後
一度設定すると、削除以外に設定変更する方法がないため注意。
