跳转到主要内容

为什么要将 Devin 与 Bitbucket 集成?

将 Devin 与你的 Bitbucket 仓库集成后,Devin 就可以创建拉取请求 (Pull Request) 、读取并回复你的 PR 评论,并与你的团队高效协作。这样,Devin 就能成为你工程团队中真正的协作伙伴。

前置条件

在设置 Bitbucket 集成之前,我们建议:
  • 专用服务账号 - 为 Devin 单独创建一个新的 Bitbucket 账号 (例如 devin@yourcompany.com) ,而不是使用现有用户账号,以便更规范地进行访问管理并保留清晰的审计记录
使用专用服务账号可以更轻松地跟踪 Devin 的活动、管理权限,并在整个组织中遵循安全最佳实践。

设置集成

Bitbucket Cloud

Bitbucket Cloud 连接分为两种。请根据你需要 Devin 完成的工作选择对应的类型: “Devin 自身写入内容”是指 Devin 创建的 pull request,以及 Devin Review 发布的发现项和描述更新。无论使用哪种连接,你在 Devin Review 中自己执行的操作 (评论、回复、拒绝 pull request) 都会以你本人的身份,通过你自己已关联的 Bitbucket 账户发布;参见 Devin Review。
无论使用哪种连接,Devin 都会自行安装 Devin Review 自动审查所需的 webhooks,但前提是该连接具备代码仓库的管理权限:即拥有 Webhooks: Read and write 和 Repositories: Admin 权限的访问令牌,或已关联 Bitbucket 账户为代码仓库管理员的 OAuth 连接。否则,该代码仓库会在连接的 webhook 状态中显示为 Skipped,并附带 Bitbucket 给出的原因;此时只有当你自己在 Devin Review 中打开 pull request 时,才会运行审查。

使用访问令牌连接

  1. 在 Bitbucket 中,为 Devin 要使用的 workspace 创建一个 workspace 访问令牌,并授予以下作用域:
    • Repositories: Admin
    • 拉取请求: Write
    • Webhooks: Read and write
    如果授予的作用域范围更小,Devin 将无法读取合并状态,也无法安装 webhook。
  2. 在您的 Devin 账户中,前往 设置 > Connections > Bitbucket,打开 Connect 按钮旁的下拉菜单,然后选择 Connect with access token。
  3. 输入 workspace ID (即 bitbucket.org/my-workspace 中的 my-workspace) 和令牌,然后点击 Connect。
Devin 会在此 workspace 中使用该令牌,并以令牌的身份 (而非你的身份) 发布内容。连接激活后,Devin 会自动在该 workspace 的代码仓库中安装 webhook;连接详情面板会显示每个代码仓库的安装结果,并提供 Refresh 按钮,用于重新运行安装。

通过 OAuth 连接

如果你的 workspace 未使用 Bitbucket Cloud Premium,请使用 OAuth。OAuth 连接使用的是已关联账户自身的 Bitbucket 授权:Devin 自身执行的写入操作 (它创建的拉取请求,以及 Devin Review 发布的发现项和描述更新) 都会以该账户的身份显示,且 webhook 只会安装在该账户拥有管理权限的代码仓库上。因此,以下步骤首先要创建一个专用的 Bitbucket 账户:切勿为组织关联某个人的账户。如果该连接是在 Devin 的 Bitbucket 应用支持管理 webhook 之前关联的,其代码仓库将显示为 Skipped,直到你替换该连接为止。
  1. 为 Devin 专门创建一个新的 Bitbucket 账户 (就像你创建个人账户那样) 。在集成过程中,你将使用这个账户,而不是你的个人账户。
  2. 在你的 Devin 账户中,进入 Settings > Connections > Bitbucket,然后点击“Connect”。
连接 Bitbucket Cloud
  1. 你会被重定向到 Bitbucket,在那里你需要:
    • 使用你为 Devin 创建的 Bitbucket 账户登录 (而不是你的个人账户)
    • 授予 Devin 访问你的代码仓库并与之协同工作的必要权限
  2. 完成后,你会回到 Devin 的设置页面,在那里你可以确认集成已启用。

替换旧的 OAuth 连接

OAuth 连接会保留其关联时获得的权限。因此,如果某个连接是在 Devin 的 Bitbucket 应用支持管理 webhook 之前关联的,其代码仓库会显示为 Skipped,webhook 状态也会提示你重新连接。该连接无法直接原地重新连接:再次连接只会新增一个同名连接,而原有连接仍保持 Skipped。正确做法是替换旧连接:
  1. 打开该连接的详情面板,记下你对它做过的更改,例如仓库权限和 Manage access。这些设置都不会迁移到新连接。
  2. 在 General 选项卡中,点击 Disconnect connection。在下一步完成之前,Devin 将无法访问这些代码仓库。
  3. 在 设置 > Connections > Bitbucket 中,打开 Connect with access token 旁的下拉菜单,选择 Connect with OAuth (any Bitbucket plan),然后使用同一个 Bitbucket 账户登录。
  4. 重新应用你在步骤 1 中记下的设置。新连接默认可访问已关联账户可见的所有 workspace。如果是企业账户,新连接默认没有任何组织访问权限,因此需要重新将其授权给你的组织。
之后,Devin 会自动安装 webhook,新连接的详情面板中会显示每个代码仓库的安装结果。 如果你已经再次连接过,则会存在两个同名连接。请记下这两个连接的设置,将两者都断开,然后按照步骤 3 和 4 重新连接一次。

Bitbucket Data Center

对于使用 Bitbucket Data Center (自托管) 的组织,请按照以下步骤操作:
  1. 在 Bitbucket Data Center 实例中为 Devin 创建一个专用服务账号。
  2. 在 Devin 账户中,前往 Settings > Connections > Bitbucket,打开 Connect 按钮旁边的下拉菜单,并选择 Connect with Bitbucket Data Center。
连接 Bitbucket Data Center
  1. 通过提供以下信息来配置连接:
    • Bitbucket Host:你的 Bitbucket Data Center 域名 (例如 bitbucket.mycompany.com)
    • Bitbucket Username:该服务账号的用户名
    • Bitbucket HTTP 访问令牌:为该服务账号创建的 HTTP 访问令牌。之后你可以在连接的详情面板中使用 Rotate access token 进行替换。
Bitbucket Data Center 配置
  1. 在 Bitbucket Data Center 实例中,为该服务账号授予相应的项目和代码仓库权限。
  2. 配置完成后,你会在 Devin 设置中看到集成状态显示为已连接。

Webhook 配置 (Bitbucket Data Center)

配置 webhook 后,Devin 可以实时接收来自 Bitbucket Data Center 的 pull request 事件,从而将 PR 状态和评论推送给正在处理该 PR 的 Devin 会话。
  1. 在你的 Devin 账户中,进入 Settings > Connections > Bitbucket,点击 Bitbucket Data Center 连接,打开其详情面板。
  2. 在 General 选项卡中,点击 Webhook 一行的 Configure。对话框会显示 webhook URL 和一个 secret 令牌——请立即复制该令牌,它只会显示一次 (之后可在同一对话框中重新生成) 。
  3. 在 Bitbucket Data Center 中,打开代码仓库或项目设置,进入 Webhooks。
  4. 创建一个 webhook,并粘贴该 webhook URL。
  5. 在 Pull request 事件下,勾选 Opened、Source branch updated、Merged、Declined 和 Comment added。
  6. 在 Authentication 下,选择 Basic,输入任意用户名,并将 secret 令牌粘贴到密码字段。
Bitbucket Cloud 连接没有 webhook 对话框:如果使用的是访问令牌连接,或者是已关联 Bitbucket 账户为该代码仓库管理员的 OAuth 连接,Devin 会自动安装 webhook。
默认情况下,Devin 在 Bitbucket Data Center 上执行的所有操作都会记在服务账号名下。关联你自己的账户后,你就可以在 Devin Review 中以本人身份发表评论、添加或移除审阅者,以及批准或拒绝 PR。 Admin 设置 (每个 Bitbucket Data Center 主机只需配置一次) :
  1. 在 Devin 中,前往 Settings > Connections > Bitbucket,然后在 Bitbucket Data Center user OAuth 下点击 Register app。对话框中会显示需要使用的重定向 URL 和权限。
  2. 在 Bitbucket Data Center 中,前往 Administration > Application links,选择 Create link,然后选择 External application 和 Incoming。粘贴重定向 URL,并授予 Repositories: Write 权限。
  3. 将该应用程序的 client ID 和客户端密钥粘贴到 Devin 对话框中,然后点击 Register。
每位用户: 在 Devin Review 提示时关联你的 Bitbucket 账户,或在 Profile 的已关联账户中进行关联。
在 Devin 中移除已注册的应用程序后,该主机上所有用户的 Bitbucket Data Center 账户都将被取消关联。

结合 Bitbucket 集成使用 Devin

连接 Bitbucket 后,请在 Devin’s Machine 上配置你的代码仓库。
Devin 如何响应 PR 评论。
  • Bitbucket Cloud:Devin 不会因其 pull request 上的评论自动唤醒。但如果你在会话中直接指出这些评论,Devin 仍可以处理。Devin 在 Cloud 连接上安装的 webhook 仅用于 Devin Review,不用于会话。
  • Bitbucket Data Center:配置好 webhook 后,某个 Devin 会话正在跟踪的 pull request 上的评论会被投递到该会话,Devin 会作出响应。组织管理员可以在 Settings > Devin > pull request 中启用 Require @Devin to respond 加以限制,这样 Devin 只会响应以 @Devin 或独立单词 Devin 开头的评论,例如 Devin fix this (devinai 前缀同样有效) 。包含 (aside) 或 !aside,以及以 aside 开头的评论则始终会被忽略。若未配置 webhook,Data Center 的行为与 Bitbucket Cloud 相同。

最佳实践

  • 为 Devin 创建一个专用的 Bitbucket 账户
  • 在 main/master 分支上启用分支保护
  • 为该服务账号授予合适的 workspace 和代码仓库权限
  • 在 Bitbucket Cloud 上通过 OAuth 连接时,请关联一个专为 Devin 创建的 Bitbucket 账户 (需为代码仓库管理员) ;Devin 将以该已关联账户的身份发布内容
  • 在 Bitbucket Data Center 上,配置 webhook,使 Devin 能够实时接收 PR 事件