From 6e17f678e755fadb8522f4ee0b58c63b95768031 Mon Sep 17 00:00:00 2001 From: mattvCypress Date: Wed, 10 May 2023 15:52:09 -0400 Subject: [PATCH] fix: update dashboard refs to cloud (#907) * update Dashboard > Cypress Cloud * updating references of dashboard to cloud * updating onlinks to point from dash to cloud --------- Co-authored-by: Ely Lucas --- .github/workflows/example-recording.yml | 4 ++-- .github/workflows/example-start-and-yarn-workspaces.yml | 4 ++-- README.md | 6 +++--- action.yml | 2 +- dist/index.js | 2 +- examples/recording/package.json | 2 +- examples/v9/recording/package.json | 2 +- index.js | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/workflows/example-recording.yml b/.github/workflows/example-recording.yml index a4d7c6d95..1325b48c3 100644 --- a/.github/workflows/example-recording.yml +++ b/.github/workflows/example-recording.yml @@ -70,7 +70,7 @@ jobs: # see "outcome" and "conclusion" of a step doc # https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#steps-context # "output" can be success, failure, cancelled, or skipped - - name: Print Dashboard URL + - name: Print Cypress Cloud URL run: | echo Cypress finished with: ${{ steps.cypress.outcome }} echo See results at ${{ steps.cypress.outputs.dashboardUrl }} @@ -128,7 +128,7 @@ jobs: # see "outcome" and "conclusion" of a step doc # https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#steps-context # "output" can be success, failure, cancelled, or skipped - - name: Print Dashboard URL + - name: Print Cypress Cloud URL run: | echo Cypress finished with: ${{ steps.cypress.outcome }} echo See results at ${{ steps.cypress.outputs.dashboardUrl }} diff --git a/.github/workflows/example-start-and-yarn-workspaces.yml b/.github/workflows/example-start-and-yarn-workspaces.yml index aa54da7be..1afe9ac52 100644 --- a/.github/workflows/example-start-and-yarn-workspaces.yml +++ b/.github/workflows/example-start-and-yarn-workspaces.yml @@ -36,7 +36,7 @@ jobs: strategy: # when one test fails, DO NOT cancel the other # containers, because this will kill Cypress processes - # leaving the Dashboard hanging ... + # leaving Cypress Cloud hanging ... # https://github.com/cypress-io/github-action/issues/48 fail-fast: false matrix: @@ -83,7 +83,7 @@ jobs: strategy: # when one test fails, DO NOT cancel the other # containers, because this will kill Cypress processes - # leaving the Dashboard hanging ... + # leaving the Cypress Cloud hanging ... # https://github.com/cypress-io/github-action/issues/48 fail-fast: false matrix: diff --git a/README.md b/README.md index 5d35cc2ec..5262c9391 100644 --- a/README.md +++ b/README.md @@ -345,7 +345,7 @@ jobs: [![recording example](https://github.com/cypress-io/github-action/workflows/example-recording/badge.svg?branch=master)](.github/workflows/example-recording.yml) -**Tip 1:** We recommend using the action with `on: [push]` instead of `on: [pull_request]` to get the most accurate information related to the commit on the dashboard. With pull requests, the merge commit is created automatically and might not correspond to a meaningful commit in the repository. +**Tip 1:** We recommend using the action with `on: [push]` instead of `on: [pull_request]` to get the most accurate information related to the commit on Cypress Cloud. With pull requests, the merge commit is created automatically and might not correspond to a meaningful commit in the repository. **Tip 2:** we recommend passing the `GITHUB_TOKEN` secret (created by the GH Action automatically) as an environment variable. This will allow correctly identifying every build and avoid confusion when re-running a build. @@ -554,7 +554,7 @@ jobs: ### Parallel -**Note:** Cypress parallelization requires a [Cypress Cloud](https://on.cypress.io/dashboard-introduction) account. +**Note:** Cypress parallelization requires a [Cypress Cloud](https://on.cypress.io/cloud-introduction) account. You can spin multiple containers running in parallel using `strategy: matrix` argument. Just add more dummy items to the `containers: [1, 2, ...]` array to spin more free or paid containers. Then use `record` and `parallel` parameters to [load balance tests](https://on.cypress.io/parallelization). @@ -1357,7 +1357,7 @@ If you add `workflow_dispatch` event to your workflow, you will be able to start ### Outputs -This action sets a GitHub step output `dashboardUrl` if the run was recorded on [Cypress Cloud](https://on.cypress.io/dashboard-introduction) using the action parameter setting `record: true` (see [Record test results on Cypress Cloud](#record-test-results-on-cypress-cloud)). Note that using a [Custom test command](#custom-test-command) with the `command` parameter overrides the `record` parameter and in this case no `dashboardUrl` step output is saved. +This action sets a GitHub step output `dashboardUrl` if the run was recorded on [Cypress Cloud](https://on.cypress.io/cloud-introduction) using the action parameter setting `record: true` (see [Record test results on Cypress Cloud](#record-test-results-on-cypress-cloud)). Note that using a [Custom test command](#custom-test-command) with the `command` parameter overrides the `record` parameter and in this case no `dashboardUrl` step output is saved. This is an example of using the step output `dashboardUrl`: diff --git a/action.yml b/action.yml index 0abb3e696..5d15e4825 100644 --- a/action.yml +++ b/action.yml @@ -4,7 +4,7 @@ description: 'GitHub Action for running Cypress end-to-end and component tests' author: 'Cypress-io' inputs: record: - description: 'Sends test results to Cypress Dashboard' + description: 'Sends test results to Cypress Cloud' required: false default: false auto-cancel-after-failures: diff --git a/dist/index.js b/dist/index.js index 3e559073d..47ca7c4a7 100644 --- a/dist/index.js +++ b/dist/index.js @@ -75180,7 +75180,7 @@ const generateSummary = async (testResults) => { .addHeading('Cypress Results', 2) .addTable([headers, summaryRows]) .addLink( - testResults.runUrl ? 'View Run in Dashboard' : '', + testResults.runUrl ? 'View run in Cypress Cloud' : '', testResults.runUrl || '' ) .write() diff --git a/examples/recording/package.json b/examples/recording/package.json index d6d1d1ee8..6c0f6cd6b 100644 --- a/examples/recording/package.json +++ b/examples/recording/package.json @@ -1,7 +1,7 @@ { "name": "example-recording", "version": "1.0.0", - "description": "recording test results to Cypress Dashboard", + "description": "recording test results to Cypress Cloud", "main": "index.js", "scripts": { "test": "cypress run", diff --git a/examples/v9/recording/package.json b/examples/v9/recording/package.json index 3b903fec3..2776f2c6f 100644 --- a/examples/v9/recording/package.json +++ b/examples/v9/recording/package.json @@ -1,7 +1,7 @@ { "name": "example-recording", "version": "1.0.0", - "description": "recording test results to Cypress Dashboard", + "description": "recording test results to Cypress Cloud", "main": "index.js", "scripts": { "test": "cypress run", diff --git a/index.js b/index.js index 3ca1ee339..8ecb03200 100644 --- a/index.js +++ b/index.js @@ -829,7 +829,7 @@ const generateSummary = async (testResults) => { .addHeading('Cypress Results', 2) .addTable([headers, summaryRows]) .addLink( - testResults.runUrl ? 'View Run in Dashboard' : '', + testResults.runUrl ? 'View run in Cypress Cloud' : '', testResults.runUrl || '' ) .write()