You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: jekyll/_cci2/enable-checks.md
+10-11Lines changed: 10 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ categories: [getting-started]
7
7
order: 1
8
8
---
9
9
10
-
This document describes how to enable the GitHub Checks CircleCI Setting and authorize the CircleCI Checks app to report workflow status to the GitHub app.
10
+
This document describes how to enable the GitHub Checks CircleCI Setting and authorize the CircleCI Checks app to report workflow status to the GitHub app. This document applies only to the cloud-hosted version of CircleCI
11
11
12
12
## Overview
13
13
@@ -25,16 +25,17 @@ To use the CircleCI Check integration, you first need to navigate to the Org Set
25
25
26
26
### Prerequisites
27
27
28
-
- You must be using the cloud-hosted version of Circle CI.
28
+
- You must be using the cloud-hosted version of CircleCI.
29
29
- Your project must be using CircleCI 2.0 with [Workflows]( {{ site.baseurl }}/2.0/workflows/).
30
30
- You must be an Admin on your GitHub repository to authorize installation of the CircleCI Checks integration.
31
31
32
32
### Steps
33
33
34
-
1.Click the Settings tab in the CircleCI app main menu.
34
+
1.In the CircleCI sidebar, select "Organization Settings"
4. Select the repositories that should utilize checks and click the Install button. 
4. Select the repositories that should utilize checks and click the Install button.
38
+
38
39
After installation completes, the Checks tab in GitHub will be populated with workflow run status information.
39
40
40
41
## Checks Status Reporting
@@ -47,19 +48,19 @@ After the rerun is initiated, CircleCI reruns the workflow from beginning and re
47
48
48
49
## To Disable GitHub Checks for a Project
49
50
50
-
To disable the CircleCI Check integration, navigate to the Org Settings Page, then remove the repositories using CircleCI Checks as follows:
51
+
To disable the CircleCI Check integration, navigate to the "Organization Settings" page, then remove the repositories using CircleCI Checks as follows:
51
52
52
53
### Steps
53
54
54
-
1. Click the Settings tab in the CircleCI app main menu.
55
+
1. Click the "Organization Settings" option in the CircleCI sidebar
@@ -80,5 +81,3 @@ Having the `ci/circleci:build` checkbox enabled will prevent the status from sho
80
81
81
82
Go to Settings > Branches in GitHub and click the Edit button on the protected branch to deselect the settings, for example `https://github.com/your-org/project/settings/branches`.
0 commit comments