Skip to content

Commit

Permalink
add GH comment section, update images, port over dashboard images
Browse files Browse the repository at this point in the history
  • Loading branch information
jaffrepaul committed Sep 11, 2023
1 parent 9ef6b05 commit 94b907a
Show file tree
Hide file tree
Showing 31 changed files with 35 additions and 26 deletions.
9 changes: 9 additions & 0 deletions docs/guides/cloud/branch-review.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -168,3 +168,12 @@ Navigating into the test detail view reveals a side-by-side comparison of the te
src="/img/guides/cloud/branch-review/test2.png"
alt="Test Comparison View"
/>

## Github Pull Request Comments

The Cypress Cloud Github Integration offers detailed test information via [PR comments](/guides/cloud/integrations/source-control/github#Pull-request-comments). Follow the "Review all test suite changes" link to load the Branch Review between the source and base branches.

<DocsImage
src="/img/guides/cloud/integrations/github/pr-comment-fail.jpg"
alt="Cypress GitHub App PR"
/>
50 changes: 25 additions & 25 deletions docs/guides/cloud/integrations/source-control/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ with your GitHub workflow via commit [status checks](#Status-checks) and
to use GitHub integration.

<DocsImage
src="/img/dashboard/github-integration/pull-request-cypress-integration-comments-github-checks.jpg"
src="/img/guides/cloud/integrations/github/pull-request-cypress-integration-comments-github-checks.jpg"
alt="Cypress GitHub App PR"
/>

Expand Down Expand Up @@ -116,7 +116,7 @@ This installation method does not apply to GitHub Enterprise.
5. Click the **Enable GitHub** button.

<DocsImage
src="/img/dashboard/github-integration/enable-github.jpg"
src="/img/guides/cloud/integrations/github/enable-github.jpg"
alt="Enable GitHub"
/>

Expand All @@ -131,7 +131,7 @@ to GitHub.com to complete the installation:
Cypress Cloud organization.

<DocsImage
src="/img/dashboard/github-integration/select-gh-org.jpg"
src="/img/guides/cloud/integrations/github/select-gh-org.jpg"
alt="Select a GitHub organization"
/>

Expand All @@ -147,7 +147,7 @@ you choose **All repositories**.
:::

<DocsImage
src="/img/dashboard/github-integration/select-gh-repos.jpg"
src="/img/guides/cloud/integrations/github/select-gh-repos.jpg"
alt="Select GitHub repositories"
width={600}
/>
Expand All @@ -174,7 +174,7 @@ them into Cypress Cloud, and complete the activation process.
App** button.

<DocsImage
src="/img/dashboard/github-integration/ghe/ghe-01.jpg"
src="/img/guides/cloud/integrations/github/ghe/ghe-01.jpg"
alt="Create new GitHub App"
/>

Expand All @@ -186,7 +186,7 @@ them into Cypress Cloud, and complete the activation process.
https://cloud.cypress.io/apps/github/callback

<DocsImage
src="/img/dashboard/github-integration/ghe/ghe-02.jpg"
src="/img/guides/cloud/integrations/github/ghe/ghe-02.jpg"
alt="Configure new GitHub App"
width={650}
/>
Expand All @@ -197,7 +197,7 @@ them into Cypress Cloud, and complete the activation process.
**Webhook secret (optional)**.

<DocsImage
src="/img/dashboard/github-integration/ghe/ghe-03.jpg"
src="/img/guides/cloud/integrations/github/ghe/ghe-03.jpg"
alt="Configure app webhook"
width={650}
/>
Expand All @@ -208,12 +208,12 @@ them into Cypress Cloud, and complete the activation process.
- **Commit statuses**: read & write

<DocsImage
src="/img/dashboard/github-integration/ghe/ghe-04-commit.jpg"
src="/img/guides/cloud/integrations/github/ghe/ghe-04-commit.jpg"
alt="Configure app permissions"
width={650}
/>
<DocsImage
src="/img/dashboard/github-integration/ghe/ghe-04-pr.jpg"
src="/img/guides/cloud/integrations/github/ghe/ghe-04-pr.jpg"
alt="Configure app permissions"
width={650}
/>
Expand All @@ -238,19 +238,19 @@ them into Cypress Cloud, and complete the activation process.
into the Cypress **GitHub Enterprise Private key** field.

<DocsImage
src="/img/dashboard/github-integration/ghe/ghe-05.jpg"
src="/img/guides/cloud/integrations/github/ghe/ghe-05.jpg"
alt="Collect new app info"
width={700}
/>

<DocsImage
src="/img/dashboard/github-integration/ghe/ghe-06.jpg"
src="/img/guides/cloud/integrations/github/ghe/ghe-06.jpg"
alt="Generate client secret"
width={680}
/>

<DocsImage
src="/img/dashboard/github-integration/ghe/ghe-07.jpg"
src="/img/guides/cloud/integrations/github/ghe/ghe-07.jpg"
width={645}
alt="Generate private key"
/>
Expand All @@ -260,15 +260,15 @@ them into Cypress Cloud, and complete the activation process.
app name\]** button.

<DocsImage
src="/img/dashboard/github-integration/ghe/ghe-08.jpg"
src="/img/guides/cloud/integrations/github/ghe/ghe-08.jpg"
width={700}
alt="Authorize GitHub App"
/>

8. On your newly-authorized GitHub App, click the **Install** button.

<DocsImage
src="/img/dashboard/github-integration/ghe/ghe-09.jpg"
src="/img/guides/cloud/integrations/github/ghe/ghe-09.jpg"
width={700}
alt="Install GitHub App"
/>
Expand All @@ -285,7 +285,7 @@ installation if you choose <strong>All repositories</strong>.
:::

<DocsImage
src="/img/dashboard/github-integration/ghe/ghe-10.jpg"
src="/img/guides/cloud/integrations/github/ghe/ghe-10.jpg"
alt="Confirm installation of GitHub App"
width={535}
/>
Expand Down Expand Up @@ -326,22 +326,22 @@ organization's Integrations page:
:::

<DocsImage
src="/img/dashboard/github-integration/org-settings-with-no-enabled-projects.jpg"
src="/img/guides/cloud/integrations/github/org-settings-with-no-enabled-projects.jpg"
alt="Org GitHub Integration settings"
/>

3. Select a GitHub repository to associate with the project.

<DocsImage
src="/img/dashboard/github-integration/project-settings-repo-selection.jpg"
src="/img/guides/cloud/integrations/github/project-settings-repo-selection.jpg"
alt="Associate GitHub repo with Cypress project"
/>

Once a GitHub repository is associated with a Cypress project, the GitHub
integration will be immediately enabled:

<DocsImage
src="/img/dashboard/github-integration/project-settings-selected-repo.jpg"
src="/img/guides/cloud/integrations/github/project-settings-selected-repo.jpg"
alt="GitHub integration enabled for Cypress project"
width={800}
/>
Expand All @@ -350,7 +350,7 @@ You can also see all GitHub Integration-enabled Cypress projects within your
organizations **Integrations** page:

<DocsImage
src="/img/dashboard/github-integration/org-settings-with-projects.jpg"
src="/img/guides/cloud/integrations/github/org-settings-with-projects.jpg"
alt="Integrations page"
/>

Expand All @@ -368,13 +368,13 @@ The Cypress GitHub App reports commit status checks in two distinct styles:
[run group](/guides/cloud/smart-orchestration/parallelization#Grouping-test-runs).**

<DocsImage
src="/img/dashboard/github-integration/status-checks-per-group.jpg"
src="/img/guides/cloud/integrations/github/status-checks-per-group.jpg"
alt="Status checks per group"
/>

- **Or one check per spec file.**
<DocsImage
src="/img/dashboard/github-integration/status-checks-per-spec.jpg"
src="/img/guides/cloud/integrations/github/status-checks-per-spec.jpg"
alt="Status checks per spec"
/>

Expand All @@ -384,7 +384,7 @@ Cypress Cloud to help you dig deeper into the problem via error messages, stack
traces, screenshots, and video recordings:

<DocsImage
src="/img/dashboard/github-integration/cloud-details-specs-tab.jpg"
src="/img/guides/cloud/integrations/github/cloud-details-specs-tab.jpg"
alt="Cypress Cloud specs tab"
/>

Expand All @@ -396,7 +396,7 @@ GitHub status checks are optional and can be disabled within a project's GitHub
integration settings:

<DocsImage
src="/img/dashboard/github-integration/status-check-settings.jpg"
src="/img/guides/cloud/integrations/github/status-check-settings.jpg"
alt="Status checks settings"
/>

Expand Down Expand Up @@ -430,7 +430,7 @@ requests via comments that include:
An example of a Cypress pull-request comment can be seen below:

<DocsImage
src="/img/dashboard/github-integration/pr-comment-fail.jpg"
src="/img/guides/cloud/integrations/github/pr-comment-fail.jpg"
alt="Cypress GitHub App PR comment"
/>

Expand All @@ -440,7 +440,7 @@ PR comments are optional and can be disabled if not needed within a project's
GitHub Integration settings:

<DocsImage
src="/img/dashboard/github-integration/pr-comments-settings.jpg"
src="/img/guides/cloud/integrations/github/pr-comments-settings.jpg"
alt="Status checks settings"
/>

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/cloud/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ and [GitLab](https://docs.gitlab.com/ee/subscriptions/self_managed/) instances
too.

<DocsImage
src="/img/dashboard/github-integration/status-checks-per-spec.jpg"
src="/img/guides/cloud/integrations/github/status-checks-per-spec.jpg"
alt="Status checks per spec"
/>

Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 94b907a

Please sign in to comment.