GitHubインテグレーション
NotionとGitHubを接続し、ワークフローを同期します 🧮
GitHubは、開発チームや企業が、ソフトウェアを構築・リリース・保守できるように支援するツールです。Notionでの仕事にGitHubを接続して、フィルターやビュー、リレーションなどの機能を持つNotionデータベースの力を活用しましょう。
NotionとGitHubのワークスペースを接続するには、Notionのワークスペースオーナー、およびGitHubのorg adminの両方の権限を持っている必要があります。
サイドバーの上部にある
設定
を開きます。自分のコネクト
をクリックし、GitHub(ワークスペース)
を見つけます。接続
をクリックし、認証フローを完了します。
Notion内で直接、ファイルまたはファイル内の特定の行にリンクします。 参照するコードを最新にしたい場合は、特定のコミットやブランチからリンクすることもできます。
これを行うには、GitHubから目的の行のパーマリンクをコピーし、Notionページに貼り付けます。表示されるメニューで プレビューとして貼り付け
を選択すると、コードがページに埋め込まれます。
GitHubのプルリクエストをNotionにリンクするには、データベースにプレフィックス付きのユニークIDプロパティが必要です。
Notionデータベース内のGitHubプルリクエストプロパティは、タスクのステータスを部門横断的なチームに自動的に通知してくれます。また、ロールアップ、数式、フィルターで使用できる属性も多数あります。
Notionデータベースで
+
をクリックし、新しいプロパティを追加します。GitHubプルリクエスト
プロパティを検索してクリックし、データベースに追加します。データベースに ユニークIDプロパティ があることを確認してください。このプロパティがデータベースにまだない場合は、追加されます。
GitHubプルリクエストプロパティを使用するには、GitHubアカウントがNotionに接続されている必要があります。 接続したら、NotionタスクのユニークIDをプルリクエストに追加するか、GitHubプルリクエストURLをプロパティに貼り付けます。
Notionはデフォルトで、NotionタスクからGitHubへのバックリンクを有効にします。 これをオフにする場合は、データベースのGitHubプルリクエストプロパティをクリックし、プロパティを編集
を選択したら、GitHubのリンクバック
をオフに切り替えます。
タスクステータス更新の自動化
このGitHubプルリクエストプロパティを使うと、Notion上のタスクのステータスを自動的に更新することができます。
GitHubプルリクエスト
のプロパティ名の部分をクリックして、プロパティを編集
を選択します。自動更新
のセクションで、ドロップダウンメニューから自動更新したいステータスプロパティを選択します。GitHubプルリクエストのOpened、Review Requested、Approved、Mergedに対応するタスクステータスを選択します。
これで、GitHubでプルリクエストに進捗があると、Notionのタスクステータスが設定に基づいて自動的に更新されるようになります。
リンクされたNotionタスクに、GitHubのアクティビティを表示することもできます。 これを行うには、データベース内のGitHubプロパティをクリックし、プロパティを編集
を選択したら、アクティビティコメント
をオンにします。
マジックワードでGitHubプルリクエストをNotionタスクにリンク
GitHubプルリクエストを1つ以上のNotionタスクにリンクする場合は、プルリクエストの説明にマジックワードとNotionタスクのユニークIDを入力するだけです。
マジックワードは、NotionタスクとGitHubプルリクエストとの間の関係を確立するのに役立つキーワードのことです。 次の単語のどれでも使えます。
close / closes / closed
fix / fixes / fixed
resolve / resolves / resolved
complete / completes / completed / completing
ref / references
part of
related to
contributes to
towards
たとえば、PRに「fixes CTT-13」という説明を付けると、IDが「CTT-13」のNotionタスクがそのプルリクエストにリンクされます。
プルリクエストの説明にタスクの終了や完了に関するマジックワードが使われている場合、プルリクエストがマージされるときにNotionタスクは完了とマークされます。
プルリクエストの説明にタスクの参照や関連に関するマジックワードが使用されている場合、プルリクエストがマージされてもNotionタスクは完了とマークされません。
Notionタスクを参照専用としてリンクすると、それらのタスクは完了としてマークされません。