NotionがGitHubと連携できるようになったので早速試してみた
先日Notionで外部ツールとの連携機能が正式リリースされたので、早速GitHubと連携してみました。
Synced Databases bridge the gap between different tools
Notionを利用して課題に感じていたこと
JCS DX推進グループでは、複数のプロジェクトのドキュメントやタスク管理でNotionを利用しています。
非常に満足しているのですが、Notion上で管理しているタスクとGitHubのPR(プルリクエスト)を同期するのが面倒という課題がありました。
NotionとGitHubを連携してみた
当記事の本題です。
連携方法はこちらの通りで非常に簡単ですが、日本語情報がないので念の為さらっと記載しておきます。
1. NotionでGitHubをアプリ登録する
Notionの左上にある Settings & Members -> My connected appsのGitHubで Connect をクリックします。
あとは画面の通りに許可するGitHub組織を選択すればOKです。
2. GitHub PRのデータベースを作成する
※GitHub連携ではイシューとPR(プルリクエスト)を同期できますが、今回はPRのみ説明します。
まずは連携するGitHubリポジトリのPRリンク(https://github.com/xxx/xxx/pulls)をコピーしておきます。
続いてNotion上のDBを作成したい箇所に先程のリンクを貼り付け、Paste as databaseを選択すればデータベースの作成は完了です。
なお、DBになっているということは、NotionからイシューやPRも更新できるの？と気になる方もいらっしゃると思いますが、機能紹介ページにある通り、
Synced Databases are read-only, so although you can bring information into Notion from GitHub and Jira, any changes to a ticket, task or PR need to be made in the original tool, providing a safeguard against unintentional edits and preserving your source of truth.
(Google翻訳)同期されたデータベースは読み取り専用であるため、GitHub や Jira から情報を Notion に取り込むことはできますが、チケット、タスク、または PR への変更は元のツールで行う必要があり、意図しない編集に対する保護を提供し、信頼できる情報源を維持します。
Notion上では読み取り専用です。
3. Notion上のデータベースと連携する
データベースを作成するだけでも一定の効果はあると思いますが、やはり連携するのであればNotion上のデータベースとも連携したいと思うのがNotionerの性というものです。
基本的な連携方法は通常のデータベースと同様、Relationカラムで行います。(Relationカラムの説明はこちらを御覧ください)
Relation先のデータベースに先程のPRデータベースを選択すると以下のような画面が表示されます。
ほとんど通常のRelationと同一ですが、Automatically Relateというものが存在していることがわかります。
こちらは機能紹介ページにある通り、
With Github and Jira Synced Databases, you can set up auto-relations, so any time an item in the Synced Database (a Github PR or a Jira Issue for example) includes a link to a Notion page in the auto-related Notion database in its description or title, the relation will automatically be populated. This makes it easier to keep track of Pull Requests and Tasks/Issues in Notion.
(Google翻訳)
Github および Jira 同期データベースを使用すると、自動関連付けを設定できるため、同期データベース内のアイテム (Github PR や Jira 課題など) に、自動関連付けされた Notion データベースの Notion ページへのリンクが含まれる場合はいつでもその説明またはタイトル、関係は自動的に入力されます。これにより、Notion でのプル リクエストとタスク/問題の追跡が容易になります。
GitHub上のイシュー、またはPR本文にNotionタスクのリンクを含めていれば、自動でリレーションを張ってくれるという大変優れた機能です。
この機能を使うことで、Notion上のタスクとPRを全自動で連携することが可能になります。
なお、2022/08/10現在、イシューやPRタイトル、ステータスを変更してからNotionに反映されないケースがありましたが、細かい使い勝手は今後のリリースに期待したいと思います。
おわりに
今回はNotionとGitHub連携というNotionerには大変興味深いリリースがありましたので、速報で機能紹介をさせていただきました。
弊社では、お客様に寄り添って開発を進めるレンタル内製チームというサービスを提供しており、ドキュメント管理にも非常に力を入れております。
ドキュメント管理をはじめとするナレッジ共有やシステム開発の内製化にご興味がありましたら、ご相談は無料で承りますので、お気軽にご連絡ください。