Skip to content

Commit

Permalink
fix: update dashboard refs to cloud (#907)
Browse files Browse the repository at this point in the history
* update Dashboard > Cypress Cloud

* updating references of dashboard to cloud

* updating onlinks to point from dash to cloud

---------

Co-authored-by: Ely Lucas <ely@meta-tek.net>
  • Loading branch information
mattvCypress and elylucas authored May 10, 2023
1 parent b0692fc commit 6e17f67
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/example-recording.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down Expand Up @@ -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 }}
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/example-start-and-yarn-workspaces.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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).

Expand Down Expand Up @@ -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`:
Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion dist/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
2 changes: 1 addition & 1 deletion examples/recording/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion examples/v9/recording/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down

0 comments on commit 6e17f67

Please sign in to comment.