Sourcegraph 集成

  • 在 SaaS 版上启用于 12.5 版本。
  • 在私有化部署版上启用于 14.8 版本。
在私有化部署版上，此功能默认启用。要隐藏此功能，禁用功能标志 sourcegraph。在 SaaS 版上，仅适用于公开项目。

Sourcegraph 提供代码智能功能，集成到 UI 中。

Sourcegraph demo

note 此功能需要用户选择加入。在您的极狐GitLab 实例启用 Sourcegraph 后，您可以选择通过您的用户偏好设置启用 Sourcegraph。

私有化部署版实例设置

在您可以在极狐GitLab 中启用 Sourcegraph 代码智能之前，使用您的极狐GitLab 实例将 Sourcegraph 实例配置为外部服务。

设置一个私有化部署的 Sourcegraph 实例

如果您是 Sourcegraph 的新手，请前往 Sourcegraph 安装文档，启动并运行您的实例。

如果您使用 HTTPS 连接到极狐GitLab，则必须为您的 Sourcegraph 实例配置 HTTPS。

将您的 Sourcegraph 实例连接到您的极狐GitLab 实例

  1. 导航到 Sourcegraph 中的站点管理中心。
  2. 配置您的极狐GitLab 外部服务。如果您已经在 Sourcegraph 中搜索了极狐GitLab 仓库，则可以跳过此步骤。
  3. 验证您是否可以通过运行测试查询，从 Sourcegraph 实例中搜索极狐GitLab 仓库。
  4. 将极狐GitLab 实例 URL 添加到站点配置中的 corsOrigin 设置。

配置极狐GitLab 实例的 Sourcegraph

  1. 在左侧边栏中，选择 搜索或转到。
  2. 选择 管理中心。
  3. 在左侧边栏中，选择 设置 > 通用。
  4. 展开 Sourcegraph 配置部分。
  5. 勾选 启用 Sourcegraph。
  6. 将 Sourcegraph URL 设置为您的 Sourcegraph 实例，例如 https://sourcegraph.example.com。

Sourcegraph administration settings

在用户偏好设置中启用 Sourcegraph

如果极狐GitLab 管理员启用了 Sourcegraph，您可以在您的用户偏好设置中启用此功能。

在极狐GitLab 中：

  1. 在右上角，选择您的头像。
  2. 选择 偏好设置。
  3. 在 集成 部分，选中 Sourcegraph 下的复选框。
  4. 选择 保存修改。

Sourcegraph user preferences

使用 Sourcegraph 代码智能

启用后，参与项目会在以下代码视图中显示代码智能弹出框：

  • 合并请求差异
  • 提交视图
  • 文件视图

当访问这些视图之一时，您现在可以将鼠标悬停在代码引用上来查看弹出窗口：

  • 有关如何定义此引用的详细信息。
  • 转到定义，导航到定义此引用的代码行。
  • 查找引用，导航到配置的 Sourcegraph 实例，显示对突出显示的代码的引用列表。

Sourcegraph demo

Sourcegraph 隐私

查看来自 Sourcegraph 的 扩展文档：

Sourcegraph 集成从不向 Sourcegraph.com 发送任何日志、ping、使用统计数据或遥测数据。 仅根据需要连接到 Sourcegraph.com，以在公共代码上提供代码智能或其它功能。 因此，不会将私有代码、私有仓库名称、用户名或任何其他特定数据发送到 Sourcegraph.com。