连接 GitHub

在此帮助文档中

连接 Notion 和 GitHub，让你的工作流程保持同步 🧮

Notion 与 GitHub 的连接使你能够无缝衔接开发工作流程。你可以直接在 Notion 页面中链接 GitHub 内容，将 GitHub 信息提取到 Notion 数据库中，并将拉取请求与 Notion 任务同步，从而让你的团队随时了解项目状态。请继续阅读以了解该连接的不同功能以及如何进行设置。

设置 GitHub 连接

Note: You can only connect one Notion workspace to a GitHub organization. If you’d like to connect a different Notion workspace to your GitHub organization, you’ll first have to disconnect your current Notion workspace.

你需要同时是 Notion 工作空间所有者和 GitHub 组织管理员，才能连接 Notion 和 GitHub 工作空间应用。

  1. 前往侧边栏中的 设置 → 连接。

  2. 找到 GitHub (工作空间)。

  3. 点击 连接 并完成身份验证流程。

创建 GitHub 代码预览

直接在 Notion 中链接到文件或文件中的特定行。如果你希望所引用的代码保持最新，甚至可以从特定的提交或分支进行链接。

  1. 从 GitHub 复制你所需代码行的 永久链接。

  2. 将其粘贴到 Notion 页面中，然后选择 粘贴为预览 以将代码嵌入到你的页面中。

创建同步数据库

你可以将 GitHub 存储库（包括拉取请求和议题）同步到 Notion 作为数据库。操作步骤如下：

  1. 在 GitHub 中，复制 PR 或议题的链接。

  2. 将链接粘贴到 Notion 中，然后选择 粘贴为数据库。

    • 如果你尚未登录，系统将提示你登录并将 Notion 与你的 GitHub 帐户连接。

  3. 同步数据库将以 表格视图 创建，并自动添加所有 GitHub 属性。

  4. 数据库将自动开始填充，即使你离开该页面，它也会继续同步。

支持的 GitHub 属性

以下是我们支持的 GitHub 属性列表：

标题

负责人

描述

州

PR 或 Issue 编号

创建者

创建时间

合并、更新和关闭时间

审核人

目前不支持标签。

人员属性

你可以使用身份映射将 GitHub 身份连接到你团队的 Notion 档案。为此，请执行以下操作：

  1. 导航至你的 GitHub email settings，并确保 Keep my email addresses private 设置 not 被勾选。

  2. 在你的 GitHub 个人资料 (https://github.com/{YOUR_USERNAME_HERE}) 中，编辑你的个人资料以添加你的 Notion （电子）邮件地址。

这使你的身份能够映射到你所属的工作空间中的同步数据库。

将 GitHub PR 关联至 Notion

To link PRs from GitHub to a Notion, you'll need a prefixed unique ID property in your database.

Learn more about unique IDs here!

Notion 数据库中的 GitHub Pull Request 属性将自动让你的跨职能团队随时了解任务状态。它还具有许多可在汇总、公式和筛选器中使用的属性。

  1. 在 Notion 数据库中，点击 + 以添加新属性。

  2. 搜索并点击 GitHub Pull Requests 以将此属性添加到你的数据库。

    • 如果你没有看到 GitHub Pull Requests 属性列表，请前往 Settings → More Settings → Connections → 添加 GitHub Pull Request。

  3. 确保你的数据库具有 Unique ID property。如果你的数据库尚无此属性，系统将为其添加。

  4. 要使用 GitHub Pull Request 属性，请确保你已将 GitHub 账户与 Notion 连接。然后，将 Notion 任务的唯一 ID 添加到拉取请求中，或者将 GitHub 拉取请求 URL 粘贴到该属性中。

默认情况下，Notion 会在 Notion 任务上启用指向 GitHub 的反向链接。如果你想关闭此功能，请点击数据库中的 GitHub Pull Request 属性 → Edit property。关闭 Linkbacks in GitHub。

自动更新任务状态

你可以使用 GitHub Pull Requests 属性自动更新 Notion 中任务的状态。

  1. 选择 GitHub Pull Requests 属性的标题，然后点击 编辑属性。

  2. 找到 自动更新 部分，并从下拉菜单中选择你想要更新的状态属性。

  3. 选择当 GitHub PR 处于“已打开”、“请求审查”、“已批准”和“已合并”状态时所要设置的任务状态。

  4. 现在，当 PR 在 GitHub 中推进时，你在 Notion 中的任务状态将根据你的设置自动更新。

你还可以在关联的 Notion 任务中显示 GitHub 活动。为此，请点击数据库中的 GitHub 属性 → 编辑属性。开启 活动评论。

GitHub Auto-update status

使用魔法词将 GitHub PR 关联到 Notion 任务

如果你想将 GitHub PR 关联到一个或多个 Notion 任务，只需在 PR 的描述中输入一个魔法词和 Notion 任务的 唯一 ID 即可。

魔法词是帮助建立 Notion 任务与 GitHub PR 之间关系的关键词。你可以使用以下任意词汇：

  • close, closes, closed

  • fix, fixes, fixed

  • resolve, resolves, resolved

  • complete, completes, completed, completing

  • ref, references

  • part of

  • 关联到

  • contributes to

  • towards

例如，你的 PR 描述可以是“fixes CTT-13”。设置该描述后，ID 为 CTT-13 的 Notion 任务将与该 PR 关联。

如果你的 PR 描述中使用了与关闭或完成任务相关的魔法词，当 PR 合并时，该 Notion 任务将被标记为已完成。

如果你的 PR 描述中使用了与引用或关联任务相关的魔法词，当 PR 合并时，该 Notion 任务不会被标记为已完成。

你可以将 Notion 任务关联为仅供参考，这样这些任务就不会被标记为已完成。

将 GitHub 与 Notion 断开连接

要将 GitHub 与 Notion 断开连接，你需要成为 Notion 工作空间所有者。

  1. 前往 设置。

  2. 选择 连接。

  3. 在 GitHub 旁边，选择 ••• → 断开所有用户连接。

当你将 GitHub 与 Notion 断开连接后，在重新设置之前，工作空间中的任何人都无法使用此连接。

给予反馈

这个资源有帮助吗？

Powered by Fruition