将 Apollo 连接到 GitHub
使用 Apollo Studio GitHub 应用增强模式检查
为增强模式检查的便捷性和实用性Apollo Studio GitHub 应用为发起的内容请求添加模式检查结果的链接:
安装 GitHub 应用程序
前往https://github.com/marketplace/apollo-studio#pricing-and-setup并点击免费安装将应用添加到您想要设置检查的 GitHub 个人资料或组织。
配置 Rover
如果您尚未安装,请在与开发环境关联安装 Rover CLI并使用 GraphOS 验证将其(详情请见 GraphOS 配置页面。)
要正确显示架构检查的结果,您需要确保Rover与请求的提交关联的是架构检查的执行,而不是 GitHub 添加的合并提交。HEAD
提交,而不是添加的合并提交。为了确保这一点,请在您动作配置中设置APOLLO_VCS_COMMIT
环境变量,如下所示:
env:APOLLO_VCS_COMMIT: ${{ github.event.pull_request.head.sha }}
对每个提交运行检查
接下来,确保您的 CI 配置包含执行架构检查的操作步骤。您可以通过在 CI 中直接添加rover subgraph check
命令来完成此操作。
💡 技巧
例如,有关 CI 配置,请参阅Rover 文档。
该rover subgraph check
命令会检查您当前分支和上次上传到GraphOS Studio的最后版本之间的架构差异。如果您已删除或更改了任何类型或字段,该命令会检查这些更改是否破坏了客户最近做出的任何查询。如果您的更改破坏了任何查询,则检查失败。
因为您已在 GitHub 上安装了 Apollo Studio 应用程序,所以在您的 GitHub 检查列表中,您添加的检查将显示为一条线路。如果有架构更改,您可以点击详细信息链接来查看它们。通过在您的持续集成工作流程(如 CircleCI)中启用架构检查,您可以直接在拉取请求中提醒开发者任何潜在问题,从而在最有用的地方提供关键反馈。