diff --git a/readme.md b/README.md
similarity index 100%
rename from readme.md
rename to README.md
diff --git a/docs/api/commands/clearallsessionstorage.mdx b/docs/api/commands/clearallsessionstorage.mdx
index ea6700c5599..1cc146cf911 100644
--- a/docs/api/commands/clearallsessionstorage.mdx
+++ b/docs/api/commands/clearallsessionstorage.mdx
@@ -8,11 +8,11 @@ data for all origins with which the test has interacted.
:::caution
-Cypress automatically runs this command _before_ each test to prevent state from
-being shared across tests when
+Cypress automatically clears all session storage _before_ each test to prevent
+state from being shared across tests when
[test isolation](/guides/core-concepts/writing-and-organizing-tests#Test-Isolation)
-is `on`. You shouldn't need to use this command unless you're using it to clear
-localStorage inside a single test or test isolation is `off`.
+is enabled. You shouldn't need to use this command unless you're using it to
+clear sessionStorage inside a single test or test isolation is disabled.
:::
diff --git a/docs/api/cypress-api/custom-commands.mdx b/docs/api/cypress-api/custom-commands.mdx
index 558501d1866..efa4ad23d39 100644
--- a/docs/api/cypress-api/custom-commands.mdx
+++ b/docs/api/cypress-api/custom-commands.mdx
@@ -7,6 +7,15 @@ Cypress comes with its own API for creating custom commands and overwriting
existing commands. The built in Cypress commands use the very same API that's
defined below.
+There are two API available for adding custom commands:
+
+- [`Cypress.Commands.add()`](#Syntax) - use to add a custom command to use when
+ writing tests
+- [`Cypress.Command.overwrite()`](#Overwrite-Existing-Commands) - use to
+ override an existing built-in Cypress command or reserved internal function.
+ **Caution:** this overrides it for Cypress as well and could impact how
+ Cypress behaves.
+
:::info
If you want your method to have builtin
diff --git a/docs/guides/cloud/organizations.mdx b/docs/guides/cloud/organizations.mdx
index f3ff5a12dc0..c23f03303ee 100644
--- a/docs/guides/cloud/organizations.mdx
+++ b/docs/guides/cloud/organizations.mdx
@@ -336,11 +336,14 @@ addition to the documentation below, refer to the Microsoft Guides for
🎉 Your integration is now complete! You can invite all of the users in your
organization to sign in through your SSO provider.
-#### **Notes**
+#### Notes
-- Once SSO is set up in Cypress Cloud, Users should be invited via your SSO
- provider, not Cypress Cloud.
+- Once SSO is successfully set up, users will need to be invited via your SSO
+ provider, as the Cypress Cloud invitation option will be disabled.
- All SSO Users are initially added with the
- [User Role](https://on.cypress.io/users#User-roles) of Member. If a User needs
+ [User Role](/guides/cloud/users#User-roles) of Member. If a User needs
different User Role permissions, this can be changed via Cypress Cloud by a
current member with the role of Owner or Admin.
+- SSO users are separate accounts from Google/GitHub or email/password users. If
+ there are duplicate users, duplicates can be removed by any
+ [Owner or Admin](/guides/cloud/users#User-roles).
diff --git a/docs/guides/cloud/projects.mdx b/docs/guides/cloud/projects.mdx
index 678039d5208..bd39059a2e3 100644
--- a/docs/guides/cloud/projects.mdx
+++ b/docs/guides/cloud/projects.mdx
@@ -3,24 +3,34 @@ title: Projects
sidebar_position: 20
---
-With Cypress, you have the ability to record your project's tests.
+:::info
+
+## What you'll learn
+
+- How to set up your project to record in Cypress Cloud
+- `projectId` and Record Key identification and usage
+- Project settings and integrations
+
+:::
+
+When you configure the open source Cypress app to record tests to Cypress Cloud,
+you'll see data from your project's latest recorded runs.
You typically want to record when running tests in
[Continuous Integration](/guides/continuous-integration/introduction), but you
can also record your tests when running locally.
-## Setup
-
-:::info
-
-To set up your project to record, you must use
-[Cypress](/guides/core-concepts/cypress-app).
+:::tip
-Make sure you [install](/guides/getting-started/installing-cypress) and
-[open](/guides/getting-started/opening-the-app) it first!
+ Make sure to
+[install](/guides/getting-started/installing-cypress) and
+[open](/guides/getting-started/opening-the-app) the Cypress app to get started
+recording!
:::
+## Setup
+
### Set up a project to record
1. Click on the **Runs** tab of your project within
@@ -29,53 +39,46 @@ Make sure you [install](/guides/getting-started/installing-cypress) and
3. You will need to log in to record your tests, so you'll be prompted to log in
to Cypress Cloud here if you haven't already done so.
4. Choose who owns the project. You can personally own it or select an
organization you're a member of. If you don't have any organizations, click
- **Create organization**. Organizations work just like they do in GitHub and
+ **Manage organizations**. Organizations work just like they do in GitHub and
enable you to separate your personal and work projects.
[Read more about organizations](/guides/cloud/organizations).
5. If you don't have any existing projects, you'll have the opportunity to
create a new one here. If you have existing projects and want to create a new
- one, you can click "Create a new project" to make a new one.
+ one, you can click **Create new** to make a new one.
+
+ - Fill in the name of your project (this is only for display purposes and can
+ be changed later).
+ - Choose whether this project is Public or Private.
-- Fill in the name of your project (this is only for display purposes and can be
- changed later).
-- Choose whether this project is Public or Private.
- - **A public project** can have its recordings and runs seen by _anyone_.
- Typically these are open source projects.
- - **A private project** restricts its access to
- _[only users you invite](/guides/cloud/users)_.
+See more about [Public-vs-Private project settings](projects#Public-vs-Private).
6. Alternatively, if you've already created a project in Cypress Cloud, you can
link your project by selecting it from the dropdown. Make sure to select a
clean project that has not previously been linked to an existing project.
7. Click **Setup Project**.
8. Now you should see a view explaining how to record your first run with your
record key.
9. After setting up your project, Cypress inserts a unique
[projectId](#Identification) into your Cypress configuration file. If you're
@@ -86,30 +89,35 @@ Make sure you [install](/guides/getting-started/installing-cypress) and
[Record Key](#Identification) while running the
[cypress run](/guides/guides/command-line#cypress-run) command.
-- Provide record key directly:
+Provide record key directly:
+
+```shell
+cypress run --record --key
+```
- ```shell
- cypress run --record --key
- ```
+Or set record key as environment variable
-- Or set record key as environment variable
- ```shell
- export CYPRESS_RECORD_KEY=
- ```
- ```shell
- cypress run --record
- ```
+```shell
+export CYPRESS_RECORD_KEY=
+```
+
+```shell
+cypress run --record
+```
🎉 Your tests are now recording! As soon as tests finish running, you will see
-them in [Cypress Cloud](https://on.cypress.io/cloud) and in the Runs tab of
+them in [Cypress Cloud](https://on.cypress.io/cloud) and in the _Runs_ tab of
[Cypress](/guides/core-concepts/cypress-app).
-
+
## Identification
@@ -150,7 +158,7 @@ export CYPRESS_PROJECT_ID={projectId}
### Record key
The record key is used to authenticate that your project is _allowed_ to record
-tests to Cypress Cloud. As long as your record key stays _private_, nobody will
+tests to Cypress Cloud. As long as your record key stays _private_, no one will
be able to record test runs for your project - even if they have your
`projectId`.
@@ -197,7 +205,7 @@ You can create multiple Record Keys for a project, or delete existing ones from
[Cypress Cloud](https://on.cypress.io/cloud).
@@ -205,153 +213,34 @@ You can also find your Record Key inside of the _Settings_ tab in the Cypress
App.
-## Record keys
-
-See [Record key](#Record-key) for a full description of how the record keys are
-used.
-
-### Create new record key
+#### Create new record key
1. Go to your organization's projects page.
2. Select the project you want to change access to.
-
3. Go to the project's **Settings** page.
-
4. Here you will see a **Record Keys** section
-
5. Click **Create New Key**. A new key will be automatically generated for your
project.
-### Delete record key
+#### Delete record key
1. Go to your organization's projects page.
2. Select the project you want to change access to.
-
3. Go to the project's **Settings** page.
-
4. Here you will see a **Record Keys** section
-
5. Click **Delete** beside the record key you want to delete.
-## Parallelization settings
-
-### Run completion delay
-
-You can edit the number of seconds that a run will wait for new groups to join
-before transitioning to 'completed'. See our
-[parallelization guide](/guides/guides/parallelization#Run-completion-delay) to
-learn more.
-
-
-
-## GitHub Integration
-
-You can integrate your project with GitHub and edit its settings from within the
-project settings page.
-
-
-
-See our [GitHub Integration guide](/guides/cloud/github-integration) to learn
-more.
-
-## Cypress Integration for Slack
-
-You can integrate your project with Slack and edit its settings from within the
-project settings page.
-
-
-
-See our [Cypress Integration for Slack guide](/guides/cloud/slack-integration)
-to learn more.
-
-## README Badges
-
-README badges allow you to increase visibility of your project's test status and
-test count to other developers viewing your project's README file.
-
-### Create a README badge
-
-1. In your Cypress Cloud account, select the project for which you’d like to
-1. On the Project Settings page, scroll down to the README Badges section and
- click “Configure Badge”.
-
-
-- **Note**: README badges are currently only available for public projects.
-
-1. A configuration modal will appear. The Project ID will be pre-filled with the
- ID associated with the project you selected. You can choose to designate a
- specific branch, or leave this field blank to always use the latest build in
- the project.
-1. Next, style your badge. Flat is the default styling and is most commonly
- used, but 5 style options are available.
-1. Select the badge type to change the amount and type of information that's
- displayed. Simple status will show only whether tests are passing or failing.
- Detailed status will show the number of tests that were passed, failed, or
- skipped. Test count will show how many tests are included in your project.
-1. Once you've selected all your settings, check out the preview and make sure
- everything looks just the way you like it.
-1. 🎉 Your badge is ready to be embedded. Copy the markdown at the bottom of the
- Configure Badge modal, and embed it in your project's README file for
- everyone to see!
-
-
+## Project settings
-See also
-[Highlight your project's test status with Cypress README badges](https://www.cypress.io/blog/2020/09/02/highlight-your-projects-test-status-with-cypress-readme-badges/)
-announcement.
-
-## Access to Runs
+### Access to Runs
Visit your project settings to see who has access to your project's runs.
-
-
-### Public vs Private
+#### Public vs Private
- **Public** means that anyone can see the recorded test runs for the project.
It is similar to how public projects on GitHub, Travis CI, or CircleCI are
@@ -363,27 +252,49 @@ Visit your project settings to see who has access to your project's runs.
someone knows your `projectId`, they will not have access to your runs unless
you have invited them.
-### Change project access
+#### Change project access
1. Go to your organization's projects page.
2. Select the project you want to change access to.
-
3. Go to the project's **Settings** page.
+4. Here you will see a section displaying **Access**. Choose the appropriate
+ access you'd like to assign.
-4. Here you will see a section displaying **Access to Runs**. Choose the
- appropriate access you'd like to assign for the project here.
-
-## Transfer ownership
+### Smart Orchestration
+
+#### Spec Prioritization & Auto Cancellation
+
+Toggle Spec Prioritization and/or adjust the number of test failures before auto
+canceling a run.
+
+Learn more about [Smart Orchestration](/guides/cloud/smart-orchestration).
+
+
-### Transfer project to other user or organization
+### Parallelization
+
+#### Run completion delay
+
+You can edit the number of seconds that a run will wait for new groups to join
+before transitioning to 'completed'. See our
+[parallelization guide](/guides/guides/parallelization#Run-completion-delay) to
+learn more.
+
+
+
+### Transfer ownership
+
+#### Transfer project to other user or organization
You can transfer projects that you own to another
[organization](/guides/cloud/organizations) you are a part of or to another user
@@ -392,55 +303,42 @@ in the organization. Projects can only be transferred from
1. Select your organization in the organization switcher.
2. Select the project you wish to transfer.
-
3. Go to the project's **Settings** page.
-
4. Scroll down to the **Transfer Ownership** section and click **Transfer
Ownership**.
5. Select the user or organization, then click **Transfer**.
-### Cancel project transfer
+#### Cancel project transfer
Upon transferring, you can cancel the transfer at any time by visiting the
organization's projects and clicking **Cancel Transfer**.
-### Accept or reject transferred project
+#### Accept or reject transferred project
When a project is transferred to you, you will receive an email notifying you.
You will be able to accept or reject the transferred project by clicking the
notification in the sidebar and clicking 'Accept' or 'Reject'.
-
-
-## Delete Project
+### Delete Project
You can delete projects you own. This will also delete all of their recorded
test runs. Deleting projects can only be done from
@@ -448,20 +346,84 @@ test runs. Deleting projects can only be done from
1. Select your organization in the organization switcher.
2. Select the project you want to remove.
-
3. Go to the project's **Settings** page.
-
4. At the very bottom of the Settings page click the **Remove Project** button.
5. Confirm that you want to delete the project by clicking **Yes, Remove
Project**.
+
+### README Badges
+
+README badges allow you to increase visibility of your project's test status and
+test count to other developers viewing your project's README file.
+
+#### Create a README badge
+
+1. In your Cypress Cloud account, select the project for which you'd like to add
+ a badge.
+2. On the Project Settings page, scroll down to the README Badges section and
+ click “Configure Badge”.
+
+:::caution
+
+**Note**: README badges are currently only available for public projects.
+
+:::
+
+3. A configuration modal will appear. The Project ID will be pre-filled with the
+ ID associated with the project you selected. You can choose to designate a
+ specific branch, or leave this field blank to always use the latest build in
+ the project.
+4. Next, style your badge. Flat is the default styling and is most commonly
+ used, but 5 style options are available.
+5. Select the badge type to change the amount and type of information that's
+ displayed. Simple status will show only whether tests are passing or failing.
+ Detailed status will show the number of tests that were passed, failed, or
+ skipped. Test count will show how many tests are included in your project.
+6. Once you've selected all your settings, check out the preview and make sure
+ everything looks just the way you like it.
+7. 🎉 Your badge is ready to be embedded. Copy the markdown at the bottom of the
+ Configure Badge modal, and embed it in your project's README file for
+ everyone to see!
+
+
+
+
+See also
+[Highlight your project's test status with Cypress README badges](https://www.cypress.io/blog/2020/09/02/highlight-your-projects-test-status-with-cypress-readme-badges/)
+announcement.
+
+## Third party integrations
+
+You can integrate your project with many third party tools and edit those
+settings from within the project settings page.
+
+See our integration guides to learn more:
+
+### CI/CD
+
+
+
+- [GitHub integration guide](/guides/cloud/github-integration)
+- [GitLab integration guide](/guides/cloud/gitlab-integration)
+- [Bitbucket integration guide](/guides/cloud/bitbucket-integration)
+
+### Project Management
+
+- [Jira integration guide](/guides/cloud/jira-integration)
+
+### Messaging
+
+- [Cypress integration for Slack guide](/guides/cloud/slack-integration)
+- Cypress integration for
+ **Microsoft Teams** guide (coming soon)
+
+
diff --git a/docs/guides/continuous-integration/github-actions.mdx b/docs/guides/continuous-integration/github-actions.mdx
index c2329268c32..52e21e53cc6 100644
--- a/docs/guides/continuous-integration/github-actions.mdx
+++ b/docs/guides/continuous-integration/github-actions.mdx
@@ -49,19 +49,14 @@ running Cypress tests. This action provides npm, pnpm or yarn installation,
custom caching, additional configuration options and simplifies setup of
advanced workflows with Cypress in the GitHub Actions platform.
-### Explicit Version Number
+### Version Number Selection
:::info
GitHub Action Version Number
-We recommend using the explicit version number of the Cypress GitHub Action to
-prevent accidentally running tests with a new version of the action that may
-have breaking changes.
-
-Read the
-[GitHub Action documentation](https://github.com/cypress-io/github-action#explicit-version)
-for more information
+We recommend binding to the action's latest major version by specifying `v5`
+when using the action.
:::
@@ -71,14 +66,21 @@ For Example:
jobs:
cypress-run:
steps:
- uses: cypress-io/github-action@v5.1.0
+ uses: cypress-io/github-action@v5
```
+Alternatively, as a mitigation strategy for unforeseen breaks, bind to a
+specific
+[release version tag](https://github.com/cypress-io/github-action/releases), for
+example `cypress-io/github-action@v5.1.0`. Read the
+[Cypress GitHub Action documentation](https://github.com/cypress-io/github-action#action-version)
+for more information.
+
## Basic Setup
-The example below is basic CI setup and job using the
+The example below is a basic CI setup and job using the
[Cypress GitHub Action](https://github.com/marketplace/actions/cypress-io) to
run Cypress tests within the Electron browser. This GitHub Action configuration
is placed within `.github/workflows/main.yml`.
@@ -86,18 +88,18 @@ is placed within `.github/workflows/main.yml`.
```yaml
name: Cypress Tests
-on: [push]
+on: push
jobs:
cypress-run:
- runs-on: ubuntu-latest
+ runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@v3
# Install NPM dependencies, cache them correctly
# and run all Cypress tests
- name: Cypress run
- uses: cypress-io/github-action@v5.x.x # use the explicit version number
+ uses: cypress-io/github-action@v5
with:
build: npm run build
start: npm start
@@ -116,11 +118,11 @@ example project and place the above GitHub Action configuration in
**How this action works:**
-- On _push_ to this repository, this job will provision and start GitHub-hosted
- Ubuntu Linux instance for running the outlined `steps` for the declared
- `cypress-run` job within the `jobs` section of the configuration.
+- On _push_ to this repository, this job will provision and start a
+ GitHub-hosted Ubuntu Linux instance to run the outlined `steps` for the
+ declared `cypress-run` job within the `jobs` section of the configuration.
- The [GitHub checkout Action](https://github.com/marketplace/actions/checkout)
- is used to checkout our code from our GitHub repository.
+ is used to check out our code from our GitHub repository.
- Finally, our Cypress GitHub Action will:
- Install npm dependencies
- Build the project (`npm run build`)
@@ -143,11 +145,11 @@ tests in Firefox by passing the `browser: firefox` attribute to the
```yaml
name: Cypress Tests using Cypress Docker Image
-on: [push]
+on: push
jobs:
cypress-run:
- runs-on: ubuntu-latest
+ runs-on: ubuntu-22.04
container: cypress/browsers:node12.18.3-chrome87-ff82
steps:
- name: Checkout
@@ -156,9 +158,9 @@ jobs:
# Install NPM dependencies, cache them correctly
# and run all Cypress tests
- name: Cypress run
- uses: cypress-io/github-action@v5.x.x # use the explicit version number
+ uses: cypress-io/github-action@v5
with:
- # Specify Browser since container image is compile with Firefox
+ # Specify Browser since container image is compiled with Firefox
browser: firefox
```
@@ -185,11 +187,11 @@ action and will save the state of the `build` directory for the worker jobs.
```yaml
name: Cypress Tests with installation job
-on: [push]
+on: push
jobs:
install:
- runs-on: ubuntu-latest
+ runs-on: ubuntu-22.04
container: cypress/browsers:node12.18.3-chrome87-ff82
steps:
- name: Checkout
@@ -203,7 +205,7 @@ jobs:
path: build
- name: Cypress install
- uses: cypress-io/github-action@v5.x.x # use the explicit version number
+ uses: cypress-io/github-action@v5
with:
# Disable running of tests within install job
runTests: false
@@ -218,13 +220,13 @@ below in a worker job.
```yaml
name: Cypress Tests with Dependency and Artifact Caching
-on: [push]
+on: push
jobs:
# install:
# ....
cypress-run:
- runs-on: ubuntu-latest
+ runs-on: ubuntu-22.04
container: cypress/browsers:node12.18.3-chrome87-ff82
steps:
- name: Checkout
@@ -239,9 +241,9 @@ jobs:
# Install NPM dependencies, cache them correctly
# and run all Cypress tests
- name: Cypress run
- uses: cypress-io/github-action@v5.x.x # use the explicit version number
+ uses: cypress-io/github-action@v5
with:
- # Specify Browser since container image is compile with Firefox
+ # Specify Browser since container image is compiled with Firefox
browser: firefox
build: yarn build
```
@@ -288,18 +290,18 @@ action will save the state of the `build` directory for the worker jobs.
```yaml
name: Cypress Tests with installation job
-on: [push]
+on: push
jobs:
install:
- runs-on: ubuntu-latest
+ runs-on: ubuntu-22.04
container: cypress/browsers:node12.18.3-chrome87-ff82
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Cypress install
- uses: cypress-io/github-action@v5.x.x # use the explicit version number
+ uses: cypress-io/github-action@v5
with:
# Disable running of tests within install job
runTests: false
@@ -336,14 +338,14 @@ action will retrieve the `build` directory saved in the install job.
```yaml
name: Cypress Tests with Install Job and UI Chrome Job x 5
-on: [push]
+on: push
jobs:
install:
# ...
ui-chrome-tests:
- runs-on: ubuntu-latest
+ runs-on: ubuntu-22.04
container: cypress/browsers:node12.18.3-chrome87-ff82
needs: install
strategy:
@@ -362,7 +364,7 @@ jobs:
path: build
- name: 'UI Tests - Chrome'
- uses: cypress-io/github-action@v5.x.x # use the explicit version number
+ uses: cypress-io/github-action@v5
with:
# we have already installed all dependencies above
install: false
@@ -417,7 +419,7 @@ the configuration that was used in the install job.
```yaml
#...
ui-chrome-tests:
- runs-on: ubuntu-latest
+ runs-on: ubuntu-22.04
container: cypress/browsers:node12.18.3-chrome87-ff82
needs: install
strategy:
@@ -486,17 +488,17 @@ identification of each build to avoid confusion when re-running a build.
```
name: Cypress tests
-on: [push]
+on: push
jobs:
cypress-run:
name: Cypress run
- runs-on: ubuntu-20.04
+ runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Cypress run
- uses: cypress-io/github-action@v5.x.x # use the explicit version number
+ uses: cypress-io/github-action@v5
with:
record: true
env:
@@ -513,17 +515,17 @@ details.
```
name: Cypress tests
-on: [push]
+on: push
jobs:
cypress-run:
name: Cypress run
- runs-on: ubuntu-20.04
+ runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Cypress run
- uses: cypress-io/github-action@v5.x.x # use the explicit version number
+ uses: cypress-io/github-action@v5
with:
record: true
env:
diff --git a/docs/guides/core-concepts/cypress-app.mdx b/docs/guides/core-concepts/cypress-app.mdx
index f5b0b585ec8..f774bf3a406 100644
--- a/docs/guides/core-concepts/cypress-app.mdx
+++ b/docs/guides/core-concepts/cypress-app.mdx
@@ -181,7 +181,7 @@ in Cypress Cloud.
The Debug page allows you to easily debug failed CI test runs from within the
Cypress app. From this page, you can review, rerun, and debug failed CI test
-runs that are recorded to Cypress Cloud (see [note above](#Overview)) – all
+runs that are recorded to Cypress Cloud (see [note above](#Overview)) - all
without leaving the Cypress app.
This feature eliminates the tedious process of switching between Cypress, your
@@ -191,10 +191,12 @@ failed in your last recorded test run, as well as review screenshots, videos,
and logs from your tests.
The Debug page shows the latest completed [test run](/guides/cloud/runs) that
-matches the HEAD commit of your local project. If no run is found for your
-current commit, then Cypress shows the most recent run in your branch's history
-up until the current commit. The first **100** failed tests are listed, with a
-link to Cypress Cloud to review the full run.
+matches the HEAD commit (the commit currently checked out in the working
+directory) of your local project. Users can see and switch to relevant runs
+within the Debug page. If no run is found for your current commit, then Cypress
+shows the most recent run in your branch's history up until the current commit.
+The first **100** failed tests are listed, with a link to Cypress Cloud to
+review the full run.
To use this feature, you must ensure that git is properly configured for your
project and that you are sending git information to Cypress Cloud. Under some
diff --git a/docs/guides/end-to-end-testing/testing-strategies/okta-authentication.mdx b/docs/guides/end-to-end-testing/testing-strategies/okta-authentication.mdx
index 7c286dc7fcb..fc0acc12031 100644
--- a/docs/guides/end-to-end-testing/testing-strategies/okta-authentication.mdx
+++ b/docs/guides/end-to-end-testing/testing-strategies/okta-authentication.mdx
@@ -221,7 +221,7 @@ Cypress.Commands.add('loginByOktaApi', (username, password) => {
issuer: `https://${Cypress.env('okta_domain')}/oauth2/default`,
clientId: Cypress.env('okta_client_id'),
redirectUri: 'http://localhost:3000/implicit/callback',
- scope: ['openid', 'email', 'profile'],
+ scopes: ['openid', 'email', 'profile'],
}
const authClient = new OktaAuth(config)
diff --git a/docusaurus.config.js b/docusaurus.config.js
index 87de392a399..aee189e5bd9 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -63,8 +63,24 @@ const config = {
],
plugins: [
- './plugins/fav-icon',
- './plugins/fullstory',
+ [
+ './plugins/osano',
+ {
+ id: 'docs-osano',
+ },
+ ],
+ [
+ './plugins/fav-icon',
+ {
+ id: 'docs-fav-icon',
+ },
+ ],
+ [
+ './plugins/fullstory',
+ {
+ id: 'docs-fullstory',
+ },
+ ],
'docusaurus-plugin-sass',
require.resolve('docusaurus-plugin-image-zoom'),
],
@@ -167,10 +183,6 @@ const config = {
href: 'https://github.com/cypress-io/cypress/discussions',
},
// {
- // label: 'Cypress Blog',
- // href: 'https://www.cypress.io/blog',
- // },
- // {
// label: 'Cypress Ambassadors',
// href: 'https://www.cypress.io/ambassadors',
// },
@@ -180,7 +192,7 @@ const config = {
// },
{
label: 'Discord',
- href: 'https://discord.gg/cMjUZg7',
+ href: 'https://discord.com/invite/cypress',
},
{
label: 'Twitter',
@@ -212,6 +224,10 @@ const config = {
label: 'About',
href: 'https://www.cypress.io/about-us',
},
+ {
+ label: 'Cypress Blog',
+ href: 'https://www.cypress.io/blog',
+ },
{
label: 'Careers',
href: 'https://www.cypress.io/careers',
@@ -249,13 +265,16 @@ const config = {
darkTheme: darkCodeTheme,
},
zoom: {
- selector: ':not(.mediaImage, .navbar__logo img)', // don't zoom these images
+ selector: ':not(.mediaImage, .navbar__logo img, .logo)', // don't zoom these images
background: {
light: 'rgb(50, 50, 50)',
dark: 'rgb(50, 50, 50)',
},
// options you can specify via https://github.com/francoischalifour/medium-zoom#usage
- config: {},
+ config: {
+ scrollOffset: 60,
+ margin: 100,
+ },
},
},
}
diff --git a/plugins/osano.js b/plugins/osano.js
new file mode 100644
index 00000000000..1cc43c89856
--- /dev/null
+++ b/plugins/osano.js
@@ -0,0 +1,17 @@
+module.exports = async function favIcon(context) {
+ return {
+ injectHtmlTags({ content }) {
+ return {
+ name: 'docusaurus-osano-plugin',
+ headTags: [
+ {
+ tagName: 'script',
+ attributes: {
+ src: 'https://cmp.osano.com/AzqisZTSBrMdc3qLt/bb12d637-24a5-47ce-8788-92e13ca795cf/osano.js',
+ }
+ },
+ ],
+ }
+ },
+ };
+};
diff --git a/src/components/logo/index.tsx b/src/components/logo/index.tsx
new file mode 100644
index 00000000000..3b81692f492
--- /dev/null
+++ b/src/components/logo/index.tsx
@@ -0,0 +1,12 @@
+import React from "react";
+
+export default function Logo({ alt, src, title }) {
+ return (
+
+ )
+}
\ No newline at end of file
diff --git a/src/css/custom.scss b/src/css/custom.scss
index a5d3f7a5d61..e64f8c8b5a9 100644
--- a/src/css/custom.scss
+++ b/src/css/custom.scss
@@ -321,3 +321,14 @@ div[class^='codeBlockTitle'] {
[class^='docItemContainer'] {
margin: 0 10px;
}
+
+/* hides the osano widget */
+.osano-cm-widget {
+ display: none;
+}
+
+.logo {
+ width: 20px;
+ display: inline-block;
+ vertical-align: text-top;
+}
\ No newline at end of file
diff --git a/src/data/plugins.json b/src/data/plugins.json
index d683dc986ba..e9d3c33597d 100644
--- a/src/data/plugins.json
+++ b/src/data/plugins.json
@@ -710,6 +710,13 @@
"link": "https://github.com/MohamadKh75/cypress-plugin-multiple-click",
"keywords": ["testing", "commands", "click"],
"badge": "community"
+ },
+ {
+ "name": "@datashard/snapshot",
+ "description": "Adds Snapshot command. Adds value / object / DOM element snapshot testing support to Cypress test runner",
+ "link": "https://github.com/datashard/snapshot",
+ "keywords": ["snapshot", "comparison", "commands"],
+ "badge": "community"
}
]
},
diff --git a/src/theme/MDXComponents.js b/src/theme/MDXComponents.js
index ac96a63531b..fd7d10aa24d 100644
--- a/src/theme/MDXComponents.js
+++ b/src/theme/MDXComponents.js
@@ -22,6 +22,7 @@ import TabItem from "@theme/TabItem";
import ThenShouldAndDifference from "@site/docs/partials/_then-should-and-difference.mdx";
import WarningPluginsFile from "@site/docs/partials/_warning-plugins-file.mdx";
import WarningSetupNodeEvents from "@site/docs/partials/_warning-setup-node-events.mdx";
+import Logo from "@site/src/components/logo";
// Font Awesome
import { library } from "@fortawesome/fontawesome-svg-core";
@@ -133,4 +134,5 @@ export default {
ThenShouldAndDifference,
WarningPluginsFile,
WarningSetupNodeEvents,
+ Logo
};
diff --git a/static/.nojekyll b/static/.nojekyll
deleted file mode 100644
index e69de29bb2d..00000000000
diff --git a/static/img/dashboard/accept-or-reject-transfer-of-project.png b/static/img/dashboard/accept-or-reject-transfer-of-project.png
deleted file mode 100644
index 6afb3d1efad..00000000000
Binary files a/static/img/dashboard/accept-or-reject-transfer-of-project.png and /dev/null differ
diff --git a/static/img/dashboard/access-to-runs.png b/static/img/dashboard/access-to-runs.png
deleted file mode 100644
index bd9edcb1a99..00000000000
Binary files a/static/img/dashboard/access-to-runs.png and /dev/null differ
diff --git a/static/img/dashboard/badges/dashboard-badge-configuration.png b/static/img/dashboard/badges/dashboard-badge-configuration.png
deleted file mode 100644
index 340c4ac30c4..00000000000
Binary files a/static/img/dashboard/badges/dashboard-badge-configuration.png and /dev/null differ
diff --git a/static/img/dashboard/badges/dashboard-badge-configure-button.png b/static/img/dashboard/badges/dashboard-badge-configure-button.png
deleted file mode 100644
index b07696cdbfb..00000000000
Binary files a/static/img/dashboard/badges/dashboard-badge-configure-button.png and /dev/null differ
diff --git a/static/img/dashboard/cancel-transfer-of-project.png b/static/img/dashboard/cancel-transfer-of-project.png
deleted file mode 100644
index f4e38eec33d..00000000000
Binary files a/static/img/dashboard/cancel-transfer-of-project.png and /dev/null differ
diff --git a/static/img/dashboard/projects/setup-a-project-1.png b/static/img/dashboard/projects/setup-a-project-1.png
deleted file mode 100644
index 4502d6e0b08..00000000000
Binary files a/static/img/dashboard/projects/setup-a-project-1.png and /dev/null differ
diff --git a/static/img/dashboard/projects/setup-a-project-2.png b/static/img/dashboard/projects/setup-a-project-2.png
deleted file mode 100644
index 9841de6579f..00000000000
Binary files a/static/img/dashboard/projects/setup-a-project-2.png and /dev/null differ
diff --git a/static/img/dashboard/projects/setup-a-project-3.png b/static/img/dashboard/projects/setup-a-project-3.png
deleted file mode 100644
index 1a8239a694b..00000000000
Binary files a/static/img/dashboard/projects/setup-a-project-3.png and /dev/null differ
diff --git a/static/img/dashboard/projects/setup-a-project-4.png b/static/img/dashboard/projects/setup-a-project-4.png
deleted file mode 100644
index 15868752e2f..00000000000
Binary files a/static/img/dashboard/projects/setup-a-project-4.png and /dev/null differ
diff --git a/static/img/dashboard/projects/setup-a-project-5.png b/static/img/dashboard/projects/setup-a-project-5.png
deleted file mode 100644
index 06f80d9fe8c..00000000000
Binary files a/static/img/dashboard/projects/setup-a-project-5.png and /dev/null differ
diff --git a/static/img/dashboard/record-key-shown-in-desktop-gui-configuration.jpg b/static/img/dashboard/record-key-shown-in-desktop-gui-configuration.jpg
deleted file mode 100644
index 245340a51b3..00000000000
Binary files a/static/img/dashboard/record-key-shown-in-desktop-gui-configuration.jpg and /dev/null differ
diff --git a/static/img/dashboard/record-keys-in-project-settings-dashboard.png b/static/img/dashboard/record-keys-in-project-settings-dashboard.png
deleted file mode 100644
index ee69e8cd727..00000000000
Binary files a/static/img/dashboard/record-keys-in-project-settings-dashboard.png and /dev/null differ
diff --git a/static/img/dashboard/remove-project-dialog.png b/static/img/dashboard/remove-project-dialog.png
index 5b155b61eb2..3b9cf364b75 100644
Binary files a/static/img/dashboard/remove-project-dialog.png and b/static/img/dashboard/remove-project-dialog.png differ
diff --git a/static/img/dashboard/run-completion-delay.jpg b/static/img/dashboard/run-completion-delay.jpg
deleted file mode 100644
index be5c975467d..00000000000
Binary files a/static/img/dashboard/run-completion-delay.jpg and /dev/null differ
diff --git a/static/img/dashboard/runs-list-in-desktop-gui.png b/static/img/dashboard/runs-list-in-desktop-gui.png
deleted file mode 100644
index 5da4de491c3..00000000000
Binary files a/static/img/dashboard/runs-list-in-desktop-gui.png and /dev/null differ
diff --git a/static/img/dashboard/transfer-ownership-button.png b/static/img/dashboard/transfer-ownership-button.png
deleted file mode 100644
index 7e49871b9f3..00000000000
Binary files a/static/img/dashboard/transfer-ownership-button.png and /dev/null differ
diff --git a/static/img/dashboard/transfer-ownership-of-project-dialog.png b/static/img/dashboard/transfer-ownership-of-project-dialog.png
deleted file mode 100644
index fde32403d96..00000000000
Binary files a/static/img/dashboard/transfer-ownership-of-project-dialog.png and /dev/null differ
diff --git a/static/img/guides/cloud/projects/accept-or-reject-transfer-of-project.jpg b/static/img/guides/cloud/projects/accept-or-reject-transfer-of-project.jpg
new file mode 100644
index 00000000000..d6c18f7222e
Binary files /dev/null and b/static/img/guides/cloud/projects/accept-or-reject-transfer-of-project.jpg differ
diff --git a/static/img/guides/cloud/projects/access-to-runs.jpg b/static/img/guides/cloud/projects/access-to-runs.jpg
new file mode 100644
index 00000000000..41173d2c752
Binary files /dev/null and b/static/img/guides/cloud/projects/access-to-runs.jpg differ
diff --git a/static/img/guides/cloud/projects/cancel-transfer-of-project.jpg b/static/img/guides/cloud/projects/cancel-transfer-of-project.jpg
new file mode 100644
index 00000000000..63ef60059e9
Binary files /dev/null and b/static/img/guides/cloud/projects/cancel-transfer-of-project.jpg differ
diff --git a/static/img/guides/cloud/projects/cloud-badge-configuration.jpg b/static/img/guides/cloud/projects/cloud-badge-configuration.jpg
new file mode 100644
index 00000000000..6587fe3de5a
Binary files /dev/null and b/static/img/guides/cloud/projects/cloud-badge-configuration.jpg differ
diff --git a/static/img/guides/cloud/projects/cloud-runs-list.jpg b/static/img/guides/cloud/projects/cloud-runs-list.jpg
new file mode 100644
index 00000000000..c77084f336c
Binary files /dev/null and b/static/img/guides/cloud/projects/cloud-runs-list.jpg differ
diff --git a/static/img/guides/cloud/projects/record-key-desktop-gui.jpg b/static/img/guides/cloud/projects/record-key-desktop-gui.jpg
new file mode 100644
index 00000000000..8faa12d4ba7
Binary files /dev/null and b/static/img/guides/cloud/projects/record-key-desktop-gui.jpg differ
diff --git a/static/img/guides/cloud/projects/record-keys-in-project-settings-dashboard.jpg b/static/img/guides/cloud/projects/record-keys-in-project-settings-dashboard.jpg
new file mode 100644
index 00000000000..a39e9a59c21
Binary files /dev/null and b/static/img/guides/cloud/projects/record-keys-in-project-settings-dashboard.jpg differ
diff --git a/static/img/guides/cloud/projects/run-completion-delay.jpg b/static/img/guides/cloud/projects/run-completion-delay.jpg
new file mode 100644
index 00000000000..cea06b2f69f
Binary files /dev/null and b/static/img/guides/cloud/projects/run-completion-delay.jpg differ
diff --git a/static/img/guides/cloud/projects/runs-list-in-desktop-gui.jpg b/static/img/guides/cloud/projects/runs-list-in-desktop-gui.jpg
new file mode 100644
index 00000000000..1bfd16f4688
Binary files /dev/null and b/static/img/guides/cloud/projects/runs-list-in-desktop-gui.jpg differ
diff --git a/static/img/guides/cloud/projects/setup-a-project-1.jpg b/static/img/guides/cloud/projects/setup-a-project-1.jpg
new file mode 100644
index 00000000000..2ec133f9cd9
Binary files /dev/null and b/static/img/guides/cloud/projects/setup-a-project-1.jpg differ
diff --git a/static/img/guides/cloud/projects/setup-a-project-2.jpg b/static/img/guides/cloud/projects/setup-a-project-2.jpg
new file mode 100644
index 00000000000..66f48692af9
Binary files /dev/null and b/static/img/guides/cloud/projects/setup-a-project-2.jpg differ
diff --git a/static/img/guides/cloud/projects/setup-a-project-3.jpg b/static/img/guides/cloud/projects/setup-a-project-3.jpg
new file mode 100644
index 00000000000..469476909ba
Binary files /dev/null and b/static/img/guides/cloud/projects/setup-a-project-3.jpg differ
diff --git a/static/img/guides/cloud/projects/setup-a-project-4.jpg b/static/img/guides/cloud/projects/setup-a-project-4.jpg
new file mode 100644
index 00000000000..3e4fdf71679
Binary files /dev/null and b/static/img/guides/cloud/projects/setup-a-project-4.jpg differ
diff --git a/static/img/guides/cloud/projects/setup-a-project-5.jpg b/static/img/guides/cloud/projects/setup-a-project-5.jpg
new file mode 100644
index 00000000000..3ee4476e56d
Binary files /dev/null and b/static/img/guides/cloud/projects/setup-a-project-5.jpg differ
diff --git a/static/img/guides/cloud/projects/transfer-ownership-button.jpg b/static/img/guides/cloud/projects/transfer-ownership-button.jpg
new file mode 100644
index 00000000000..ca88bacc4c6
Binary files /dev/null and b/static/img/guides/cloud/projects/transfer-ownership-button.jpg differ
diff --git a/static/img/guides/cloud/projects/transfer-ownership-of-project-dialog.jpg b/static/img/guides/cloud/projects/transfer-ownership-of-project-dialog.jpg
new file mode 100644
index 00000000000..1aa80271404
Binary files /dev/null and b/static/img/guides/cloud/projects/transfer-ownership-of-project-dialog.jpg differ
diff --git a/static/img/guides/core-concepts/cypress-app/debug-page.png b/static/img/guides/core-concepts/cypress-app/debug-page.png
index a5d77bca48d..f32c2352452 100644
Binary files a/static/img/guides/core-concepts/cypress-app/debug-page.png and b/static/img/guides/core-concepts/cypress-app/debug-page.png differ
diff --git a/static/img/logo/bitbucket.svg b/static/img/logo/bitbucket.svg
new file mode 100644
index 00000000000..cdf84686d93
--- /dev/null
+++ b/static/img/logo/bitbucket.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/static/img/logo/github-white.svg b/static/img/logo/github-white.svg
new file mode 100644
index 00000000000..d5e64918546
--- /dev/null
+++ b/static/img/logo/github-white.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/static/img/logo/github.svg b/static/img/logo/github.svg
new file mode 100644
index 00000000000..37fa923df33
--- /dev/null
+++ b/static/img/logo/github.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/static/img/logo/gitlab.svg b/static/img/logo/gitlab.svg
new file mode 100644
index 00000000000..9e3467443a1
--- /dev/null
+++ b/static/img/logo/gitlab.svg
@@ -0,0 +1,6 @@
+
diff --git a/static/img/logo/jira.svg b/static/img/logo/jira.svg
new file mode 100644
index 00000000000..4ace5cc84a3
--- /dev/null
+++ b/static/img/logo/jira.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/static/img/logo/ms-teams.svg b/static/img/logo/ms-teams.svg
new file mode 100644
index 00000000000..d9205bb8935
--- /dev/null
+++ b/static/img/logo/ms-teams.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/static/img/logo/slack.svg b/static/img/logo/slack.svg
new file mode 100644
index 00000000000..69a4eb6a217
--- /dev/null
+++ b/static/img/logo/slack.svg
@@ -0,0 +1 @@
+
\ No newline at end of file