設定すること
- Elidoに接続するLinearのパーソナルAPIキー。OAuthもアプリ登録も不要です。
- Elidoのリンク切れモニターが動作しなくなった宛先を検出したときに、Linearで自動的にIssueを作成する。
- Elidoワークスペースごとに、対象のLinearチームを1つ指定する。
Linear連携は、Elidoがリンク切れ(宛先がエラーを返すか応答しなくなった短縮リンク)を検出すると、自動的にIssueを作成します。リンク切れモニターは、1日に1回リンクをチェックします。
必要なもの
- 対象チームでIssueを作成する権限を持つLinearアカウント。
- LinearのパーソナルAPIキー(生成には30秒ほどかかります)。
- ワークスペースの連携を管理できるElidoのロール。
LinearのAPIキーを生成する
- Linear → Settings → API → Personal API keysに進みます。
- Create keyをクリックします。「Elido integration」のようなラベルを付けます。
- キーをコピーします。Linearが表示するのは一度だけです。
Elidoで設定する
- Dashboard → Integrations → Linearに進みます。
- APIキーを貼り付けて検証します。Elidoは、キーがアクセスできるすべてのチームを一覧表示します。
- 対象のチームを選択します。Issueはそこに作成されます。
- 保存します。キーは暗号化されて保存されます。
Linearに書き込まれる内容
リンクが初めてリンク切れと検出されたとき(および24時間後もまだ壊れている場合は再度)、Elidoは「Broken link: [short URL]」というタイトルのIssueを1件作成します。内容は次のとおりです:
- 短縮URLと宛先URL。
- 取得できる場合は、HTTPステータスコードとエラーメッセージ。
- Elidoが問題を検出した時刻。
Elidoは検出ごとに1件のIssueだけを作成し、Linearからの読み戻しは行いません。Issueのクローズや状態の追跡はしません。その部分は、チームのワークフローに任されます。
トラブルシューティング
キーの検証時に「Not authorized」と表示される。 APIキーが間違っているか、失効しています。Linear Settings → APIから再生成してください。
Issueが間違ったチームに作成される。 Dashboard → Integrations → Linearでチームの選択を確認してください。キーが複数のチームにアクセスできる場合、ピッカーが最初のチームを既定にしていることがあります。
Issueが作成されない。 Issueを作成するのはリンク切れだけです。Linearの接続が接続済みと表示され、失効していないことを確認してください。
Issueが重複する。 Elidoは検出ごとに最大1件のIssueを作成します。重複が見られる場合は、同じLinearチームが2つのElidoワークスペースに接続されていないか確認してください。