Skip to content

Commit d1a1a61

Browse files
authored
Merge pull request circleci#4630 from circleci/4606-github-checks
Add: updated screenshots and instructions.
2 parents 2eb2189 + 7129d53 commit d1a1a61

File tree

3 files changed

+10
-11
lines changed

3 files changed

+10
-11
lines changed

jekyll/_cci2/enable-checks.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ categories: [getting-started]
77
order: 1
88
---
99

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
1111

1212
## Overview
1313

@@ -25,16 +25,17 @@ To use the CircleCI Check integration, you first need to navigate to the Org Set
2525

2626
### Prerequisites
2727

28-
- You must be using the cloud-hosted version of Circle CI.
28+
- You must be using the cloud-hosted version of CircleCI.
2929
- Your project must be using CircleCI 2.0 with [Workflows]( {{ site.baseurl }}/2.0/workflows/).
3030
- You must be an Admin on your GitHub repository to authorize installation of the CircleCI Checks integration.
3131

3232
### Steps
3333

34-
1. Click the Settings tab in the CircleCI app main menu.
34+
1. In the CircleCI sidebar, select "Organization Settings"
3535
2. Select VCS.
36-
3. Click the Manage GitHub Checks button. ![CircleCI VCS Settings Page]( {{ site.baseurl }}/assets/img/docs/checks_setting.png)
37-
4. Select the repositories that should utilize checks and click the Install button. ![CircleCI VCS Settings Page]( {{ site.baseurl }}/assets/img/docs/checks_install.png)
36+
3. Click the **Manage GitHub Checks** button. ![CircleCI VCS Settings Page]( {{ site.baseurl }}/assets/img/docs/screen_github_checks_new_ui.png)
37+
4. Select the repositories that should utilize checks and click the Install button.
38+
3839
After installation completes, the Checks tab in GitHub will be populated with workflow run status information.
3940

4041
## Checks Status Reporting
@@ -47,19 +48,19 @@ After the rerun is initiated, CircleCI reruns the workflow from beginning and re
4748

4849
## To Disable GitHub Checks for a Project
4950

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:
5152

5253
### Steps
5354

54-
1. Click the Settings tab in the CircleCI app main menu.
55+
1. Click the "Organization Settings" option in the CircleCI sidebar
5556
2. Select VCS.
56-
3. Click the Manage GitHub Checks button. The Update CircleCI Checks repository access page appears. ![CircleCI VCS Settings Page]( {{ site.baseurl }}/assets/img/docs/checks_update.png)
57+
3. Click the Manage GitHub Checks button. The Update CircleCI Checks repository access page appears.
5758
4. Deselect the repository to uninstall the Checks integration.
5859
5. Confirm the status settings on your projects: Go to CircleCI > Project
5960
Settings > Advanced Settings > Confirm that the setting `GitHub Status
6061
Updates` is set to `on`.
6162

62-
![Re-enable GitHub Status]({{ site.baseurl }}/assets/img/docs/github-checks-enable-updates.png)
63+
![CircleCI VCS Settings Page]( {{ site.baseurl }}/assets/img/docs/screen_github_checks_disable_new_ui.png)
6364

6465
## To Uninstall Checks for the Organization
6566

@@ -80,5 +81,3 @@ Having the `ci/circleci:build` checkbox enabled will prevent the status from sho
8081

8182
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`.
8283

83-
84-
Loading
Loading

0 commit comments

Comments
 (0)