-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into branch-review
- Loading branch information
Showing
13 changed files
with
149 additions
and
165 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,157 +4,150 @@ sidebar_position: 10 | |
| sidebar_label: Introduction | ||
| --- | ||
|
|
||
| :::tip | ||
| [Cypress Cloud](https://on.cypress.io/cloud) is our enterprise-ready companion | ||
| to the open-source Cypress app, allowing you to: | ||
|
|
||
| - [View past test results](#View-past-test-results) from your CI environment. | ||
| - [Analyze and diagnose](#Analyze-and-diagnose-test-health) test health. | ||
| - [Reduce test time and save money](#Reduce-test-time--CI-costs) by smartly | ||
| orchestrating future runs across multiple machines. | ||
| - [Integrate with your favorite developer tools](#Integrate-with-your-favorite-tools) | ||
| to help streamline your workflows. | ||
| - [View CI runs and test health](#Cypress-app-integration) directly from the | ||
| Cypress app. | ||
| - [Configure Cypress Cloud how you want](#Flexible-enterprise-configuration-and-single-sign-on) and enable enterprise single sign on. | ||
|
|
||
| [Get started with Cypress Cloud](/guides/cloud/getting-started) for free now, or | ||
| read on for more benefits of Cypress Cloud. | ||
|
|
||
| <strong> | ||
| <Icon name="star" /> Get Started | ||
| </strong> | ||
|
|
||
| To get started with Cypress Cloud, | ||
| [sign up here](https://cloud.cypress.io/signup) for our | ||
| [free plan](https://www.cypress.io/pricing) which comes with 3 users and 500 | ||
| monthly test results. | ||
|
|
||
| ::: | ||
|
|
||
| [Cypress Cloud](https://on.cypress.io/cloud) is our enterprise-ready, web-based | ||
| companion to the Cypress app. It gives you online access to your recorded test | ||
| results, orchestrates test runs across multiple machines, provides rich | ||
| analytics and diagnostics, and integrates those insights with your favorite | ||
| tools. | ||
|
|
||
| <!-- textlint-disable --> | ||
|
|
||
| <DocsVideo src="https://vimeo.com/736212167" /> | ||
|
|
||
| <!-- textlint-enable --> | ||
|
|
||
| :::info | ||
|
|
||
| ##### <Icon name="graduation-cap" /> Real World Example <Badge type="success">New</Badge> | ||
|
|
||
| The Cypress | ||
| [Real World App (RWA)](https://github.com/cypress-io/cypress-realworld-app) | ||
| leverages [Cypress Cloud in CI](https://cloud.cypress.io/projects/7s5okt) to | ||
| test over 300 test cases in parallel across 25 machines, multiple browsers, | ||
| multiple device sizes, and multiple operating systems. | ||
| ## Benefits | ||
|
|
||
| Check out the <Icon name="github" /> | ||
| [Real World App in Cypress Cloud](https://cloud.cypress.io/projects/7s5okt). | ||
| ### View past test results | ||
|
|
||
| ::: | ||
| Each test run is stored in Cypress Cloud, where you can see past results and the | ||
| current state of your app on the [Latest Runs](/guides/cloud/recorded-runs) page. View | ||
| each test's | ||
| [command logs, screenshots, video replays, stack traces, and CI logs](/guides/cloud/recorded-runs#Test-detail-sidebar). | ||
| Quickly identifying a test failure in CI is just a click away. | ||
|
|
||
| ## Benefits | ||
| <DocsVideo src="https://vimeo.com/806005654" /> | ||
|
|
||
| ### Analyze and diagnose | ||
| ### Analyze and diagnose test health | ||
|
|
||
| Store the full history of your test results, with | ||
| [video clips, screenshots, and full stack traces](/guides/cloud/recorded-runs#Attempts-and-errors). | ||
| Quickly see the current state of your app on the | ||
| [Latest Runs](/guides/cloud/recorded-runs#Latest-Runs) page, identify | ||
| problematic trends with rich [Analytics](/guides/cloud/analytics), and diagnose | ||
| unreliable tests with | ||
| [Flaky Test Management](/guides/cloud/flaky-test-management). Associate related | ||
| tests with | ||
| [grouping](/guides/cloud/smart-orchestration/parallelization#Grouping-by-browser) | ||
| to see results broken down by browser and OS. | ||
| View each [run's overview](/guides/cloud/recorded-runs#Overview-tab) to see and compare | ||
| past runs and analyze trends over time. You can quickly analyze changes in your | ||
| setup that might introduce problematic trends as well as identify unreliable | ||
| tests with [Flaky Test Management](/guides/cloud/flaky-test-management). | ||
|
|
||
| <DocsImage | ||
| src="/img/dashboard/dashboard-runs-list.png" | ||
| alt="Cloud Screenshot" | ||
| /> | ||
| <DocsVideo src="https://vimeo.com/806900039" /> | ||
|
|
||
| For users of the open-source [Cypress app](/guides/core-concepts/cypress-app), | ||
| we've integrated test run information from Cypress Cloud so developers can see | ||
| the latest results across the team, and identify areas of concern. | ||
| The [analytics](/guides/cloud/analytics) page shows test metrics over time, | ||
| helping determine the overall health of your test suite. Quickly see which tests | ||
| are problematic, getting slower, or growing over time. | ||
|
|
||
| <DocsImage | ||
| src="/img/dashboard/v10/runs-list-in-cypress-app.png" | ||
| alt="Runs List" | ||
| src="/img/guides/cloud/analytics/analytics-runstatus.jpg" | ||
| alt="Analytics run status" | ||
| /> | ||
|
|
||
| ### Run tests in parallel, in priority order, or not at all | ||
| ### Reduce test time & CI costs | ||
|
|
||
| With our [Smart Orchestration](/guides/cloud/smart-orchestration/overview) | ||
| features, you can run tests across a swarm of machines simultaneously while | ||
| [Smart Orchestration](/guides/cloud/smart-orchestration/overview) enables you to run | ||
| tests across multiple machines simultaneously in your CI environment while | ||
| Cypress Cloud coordinates runners and | ||
| [balances test loads](/guides/cloud/smart-orchestration/load-balancing#Balance-strategy) - | ||
| no setup required! You can prioritize recently failed specs with | ||
| [Spec Prioritization](/guides/cloud/smart-orchestration/spec-prioritization) to | ||
| surface problems earlier, and cancel whole test runs on failure with | ||
| [Auto Cancellation](/guides/cloud/smart-orchestration/run-cancellation) to save | ||
| on resource usage. You can also | ||
| [cancel in-progress runs](/guides/cloud/recorded-runs#Run-cancellation) manually | ||
| from Cypress Cloud if you need to. | ||
| [balances test loads](/guides/cloud/smart-orchestration/load-balancing#Balance-strategy) - no setup required! | ||
|
|
||
| <DocsImage | ||
| src="/img/dashboard/introduction/orchestration-diagram.png" | ||
| alt="Diagram comparing serial and parallel test configurations" | ||
| /> | ||
|
|
||
| ### Integrate with source control providers | ||
|
|
||
| Ensure rock-solid reliability by keeping failing code out of your | ||
| [GitHub](https://github.com), [GitLab](https://gitlab.com) and | ||
| [Bitbucket](https://bitbucket.org) repositories, with | ||
| [status checks](/guides/cloud/integrations/source-control/github#Status-checks) | ||
| that block commits from being merged until your Cypress tests are green. Surface | ||
| test results directly in your PRs with | ||
| [pull request comments](/guides/cloud/integrations/source-control/github#Pull-request-comments) | ||
| that include test run statistics, specific failure details, and deep links to | ||
| results in Cypress Cloud for fast debugging. Users with | ||
| [Business or Enterprise plans](https://www.cypress.io/pricing/) can integrate | ||
| securely with | ||
| [Self-managed GitLab](https://docs.gitlab.com/ee/subscriptions/self_managed/) | ||
| instances too. | ||
| Cypress Cloud's | ||
| [Spec Prioritization](/guides/cloud/smart-orchestration/spec-prioritization) | ||
| lets you prioritize recently failed specs so they run faster on their next run. | ||
| The [Auto Cancellation](/guides/cloud/smart-orchestration/run-cancellation) | ||
| feature will cancel a whole test run on failure, saving time and resource usage. | ||
| You can also [cancel in-progress runs](/guides/cloud/recorded-runs#Run-cancellation) | ||
| manually from Cypress Cloud if you need to. | ||
|
|
||
| ### Integrate with your favorite tools | ||
|
|
||
| #### Source Control providers | ||
|
|
||
| Cypress Cloud integrates with [GitHub](/guides/cloud/integrations/source-control/github), | ||
| [GitLab](/guides/cloud/integrations/source-control/gitlab), and | ||
| [Bitbucket](/guides/cloud/integrations/source-control/bitbucket) to provide rock-solid | ||
| reliability by keeping failing code out of your main branch. Use status checks | ||
| to block commits from being merged until your Cypress tests are green, and | ||
| surface test results directly in your PRs with pull request comments that | ||
| include test run statistics, specific failure details, and deep links to results | ||
| in Cypress Cloud for fast debugging. | ||
|
|
||
| [Business and Enterprise plans](https://www.cypress.io/pricing/) include secure | ||
| integration with self-managed | ||
| [GitHub](https://docs.github.com/en/[email protected]/admin/overview/about-github-enterprise-server) | ||
| and [GitLab](https://docs.gitlab.com/ee/subscriptions/self_managed/) instances | ||
| too. | ||
|
|
||
| <DocsImage | ||
| src="/img/dashboard/github-integration/status-checks-per-spec.jpg" | ||
| alt="Status checks per spec" | ||
| /> | ||
|
|
||
| ### Collaborate and organize | ||
| #### Team Communication | ||
|
|
||
| We also integrate with two of the world's most popular collaboration tools: | ||
| [Slack](https://slack.com/) and [Jira](https://www.atlassian.com/software/jira). | ||
| Deliver test results with valuable additional context, directly into a dedicated | ||
| Slack channel. Or for those on the | ||
| [Team, Business or Enterprise plans](https://www.cypress.io/pricing/), | ||
| [create bidirectionally linked Jira tickets](/guides/cloud/integrations/jira#Creating-a-Jira-issue-for-a-test-case) | ||
| directly from specific test failures. | ||
| Get notified on test progress directly in your team's | ||
| [Slack](/guides/cloud/integrations/slack) or | ||
| [Microsoft Teams](/guides/cloud/integrations/teams) channels. | ||
|
|
||
| <DocsImage | ||
| src="/img/dashboard/slack-integration/cypress-slack-integration-channel-feed.jpg" | ||
| alt="Cypress notification feed in Slack channel" | ||
| width={560} | ||
| /> | ||
|
|
||
| Lastly you can use our flexible adminstrative functions to configure Cypress | ||
| Cloud however you want, grouping | ||
| #### Issue Management | ||
|
|
||
| Keep the whole team up-to-date with [Jira](/guides/cloud/integrations/jira) | ||
| integration. You can | ||
| [create bidirectionally linked Jira tickets](/guides/cloud/integrations/jira#Creating-a-Jira-issue-for-a-test-case) | ||
| directly from specific test failures. | ||
|
|
||
| ### Cypress app integration | ||
|
|
||
| The [Cypress app](/guides/cloud/recorded-runs#Cypress-App) integrates directly with | ||
| Cypress Cloud to provide developers with the latest test results without having | ||
| to switch tools. | ||
|
|
||
| <DocsImage | ||
| src="/img/guides/core-concepts/cypress-app/debug-page.png" | ||
| alt="Debug" | ||
| /> | ||
|
|
||
| ### Flexible enterprise configuration and single sign on | ||
|
|
||
| You can use our flexible administrative functions to configure Cypress Cloud however you want, grouping | ||
| [projects](/guides/cloud/account-management/projects) into multiple | ||
| [organizations](/guides/cloud/account-management/organizations) if you have a | ||
| lot, checking [usage](/guides/cloud/account-management/billing-and-usage), and | ||
| administering | ||
| [users and permissions](/guides/cloud/account-management/users#User-roles). We | ||
| also provide [SSO integration](/guides/cloud/account-management/enterprise-sso) | ||
| [users and permissions](/guides/cloud/account-management/users#User-roles). | ||
|
|
||
| We also provide [SSO integration](/guides/cloud/account-management/enterprise-sso) | ||
| for teams on our [Enterprise plan](https://www.cypress.io/pricing/). | ||
|
|
||
| ## Example project | ||
|
|
||
| The Cypress | ||
| [Real World App (RWA)](https://github.com/cypress-io/cypress-realworld-app) | ||
| leverages [Cypress Cloud in CI](https://cloud.cypress.io/projects/7s5okt) to | ||
| test over 300 test cases in parallel across 25 machines, multiple browsers, | ||
| multiple device sizes and multiple operating systems. | ||
|
|
||
| :::info | ||
|
|
||
| <strong>Have a question you don't see answered here?</strong> | ||
|
|
||
| [We have answered some common questions about Cypress Cloud in our FAQ](/faq/questions/cloud-faq). | ||
|
|
||
| ::: | ||
|
|
||
| ## Example projects | ||
|
|
||
| Once you log in to [Cypress Cloud](https://on.cypress.io/cloud) you can view any | ||
| [public project](/guides/cloud/account-management/projects#Public-vs-Private). | ||
|
|
||
| **Here are some of our own public projects you can view:** | ||
|
|
||
| - [<Icon name="folder-open" /> cypress-realworld-app](https://cloud.cypress.io/projects/7s5okt) | ||
| - [<Icon name="folder-open" /> cypress-example-recipes](https://cloud.cypress.io/#/projects/6p53jw) | ||
| - [<Icon name="folder-open" /> cypress-example-kitchensink](https://cloud.cypress.io/#/projects/4b7344) | ||
| - [<Icon name="folder-open" /> cypress-example-todomvc](https://cloud.cypress.io/#/projects/245obj) | ||
Oops, something went wrong.