启用GitHub的检查

本文介绍如何启用GitHub的检查CircleCI设置和授权CircleCI检查应用报告工作流状态到GitHub的应用。GitHub的检查集成功能目前尚未提供CircleCI服务器上。

概观

GitHub的检查提供了GitHub的检查页面上您的工作状态信息,使您能够重新运行从GitHub的检查页的工作流。

检查启用后,CircleCI工作流程和工作状态在GitHub上检查选项卡下的报道。

CircleCI检查

注意:GitHub上目前不提供细粒度的方式为您重新运行工作流程。Because CircleCI uses checks that are mapped to workflows (e.g. a single configuration may have one or more workflows), when you select the Re-run checks button, you will automatically re-run all checks, regardless of whether you selected “re-run failed checks” or “rerun all checks” from the Re-run checks button.

启用GitHub的检查

要使用CircleCI检查的整合,首先需要导航到组织设置,然后认证使用CircleCI检查库如下:

先决条件

  • 您必须使用CircleCI的云托管版本。
  • 你的项目必须使用CircleCI 2.0工作流程
  • 您必须对您的GitHub仓库管理员的授权安装CircleCI检查集成。

脚步

  1. 在CircleCI栏,选择“组织设置”
  2. 选择VCS。
  3. 点击管理GitHub的检查按钮。CircleCI VCS设置页面
  4. 选择要使用的检查,然后点击安装按钮库。

安装完成后,在GitHub上的检查标签将与流运行状态信息进行填充。

检查状态报告

CircleCI报告在GitHub上检查选项卡下的工作流程和所有相应作业的状态。此外,检查提供了一个按钮重新运行从GitHub检查选项卡的每个工作流。

重新运行开始后,从CircleCI开始重新运行的工作流程和转播的检查标签上的状态。导航到从GitHub上的CircleCI应用,请点击查看关于CircleCI检查的详细信息链接。

注意:您的项目将停止接收GitHub的检查后工作​​水平状态被打开。您可以在项目设置>高级设置页面GitHub的状态更新部分改变这一点。

要禁用GitHub的检查一个项目

要禁用CircleCI检查集成,导航到“组织设置”页面,然后取出用CircleCI检查如下库:

脚步

  1. 点击“组织设置”选项,在CircleCI侧边栏
  2. 选择VCS。
  3. 单击管理GitHub的检查按钮。更新CircleCI检查仓库的访问页面。
  4. 取消仓库卸载检查集成。
  5. 确认状态设置你的项目:转到CircleCI>项目设置>高级设置>确认设置GitHub的状态更新被设定为

CircleCI VCS设置页面

卸载检查的组织

  1. 点击CircleCI应用程序主菜单的设置选项卡。
  2. 选择VCS。
  3. 单击管理GitHub的检查按钮。
  4. 向下滚动,然后点击卸载按钮来卸载GitHub的检查程序。

GitHub的检查在GitHub上等待状态

CI / circleci:编译 - 等待上报状态

如果您已启用在GitHub的库GitHub的检查,但状态检查GitHub的检查标签上无法完成,有可能是在GitHub的状态设置,您需要取消选择。例如,如果您选择,以保护您的分支,您可能需要取消CI / circleci:构建地位的关键,因为这支票是指从CircleCI 2.0作业状态,如下所示:

取消选中GitHub的作业状态键

具有CI / circleci:构建启用复选框将不会展示使用GitHub的检查时,在GitHub上为已完成状态,因为CircleCI职位状态到GitHub上的工作流水平,而不是一个工作流程的工作水平。

进入设置>分行GitHub上,并单击编辑按钮上受保护的分支取消设置,例如https://github.com/your-org/project/settings/branches