@cypress/github-action 5.7.2 → 5.8.0

package/README.md

@@ -55,6 +55,10 @@
 
 Current examples contained in this repository are based on Cypress 12.x and can be found in the [examples](./examples) directory. Examples for [Legacy Configuration](https://on.cypress.io/guides/references/legacy-configuration) use Cypress `9.7.0` and are kept in the [examples/v9](./examples/v9) directory.
 
+Live examples, such as [example-basic.yml](.github/workflows/example-basic.yml) are shown together with a status badge. Click on the status badge to read the source code of the workflow, for example
+
+[![End-to-End example](https://github.com/cypress-io/github-action/workflows/example-basic/badge.svg?branch=master)](.github/workflows/example-basic.yml)
+
 Some older **external** examples, linked to by this document, are based solely on Cypress 9 and below and therefore use a [Legacy Configuration](https://on.cypress.io/guides/references/legacy-configuration). These may need modification to be applied to Cypress 10 and later. Each of these external links is listed with a `(legacy)` notation.
 
 **Note:** this package assumes that [cypress](https://www.npmjs.com/package/cypress) is declared as a development dependency in the [package.json](https://docs.npmjs.com/creating-a-package-json-file) file. The [cypress npm module](https://www.npmjs.com/package/cypress) is required to run Cypress via its [Module API](https://on.cypress.io/module-api).
@@ -262,7 +266,7 @@ jobs:
           CYPRESS_port: 4222
 ```
 
-For more examples, see the workflow example below.
+For more examples, see the workflows below, using environment variables for [recording](#record-test-results-on-cypress-cloud).
 
 [![Env example](https://github.com/cypress-io/github-action/workflows/example-env/badge.svg?branch=master)](.github/workflows/example-env.yml)
 
@@ -287,7 +291,7 @@ jobs:
           spec: cypress/e2e/spec1.cy.js
 ```
 
-You can pass multiple specs and wild card patterns using multi-line parameter, see [example-config.yml](./.github/workflows/example-config.yml):
+You can pass multiple specs and wild card patterns using multi-line parameter, see [example-config.yml](.github/workflows/example-config.yml):
 
 ```yml
 spec: |
@@ -345,13 +349,13 @@ 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 Cypress Cloud. 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.
 
 **Tip 3:** if running on `pull_request` event, the commit message is "merge SHA into SHA", which is not what you want probably. You can overwrite the commit message sent to Cypress Cloud by setting an environment variable. See [issue 124](https://github.com/cypress-io/github-action/issues/124#issuecomment-653180260) for details.
 
-**Tip 4:** to record the project needs `projectId`. Typically this value is saved in the `cypress.json` file. If you want to avoid this, pass the project id using an environment variable:
+**Tip 4:** to record the project needs `projectId`. Typically this value is saved in the [Cypress Configuration File](https://docs.cypress.io/guides/references/configuration#Configuration-File). If you want to avoid this, pass the `projectId` using an environment variable:
 
 ```yml
 name: Cypress tests
@@ -618,6 +622,8 @@ During staged rollout of a new GitHub-hosted runner version, GitHub may provide
     component: true
 ```
 
+See the example project [component-test](examples/component-tests/) and the [example-component-test.yml](.github/workflows/example-component-test.yml) workflow for more details.
+
 ### Build app
 
 You can run a build step before starting tests
@@ -639,7 +645,7 @@ jobs:
 
 ### Start server
 
-If your tests run against a local server, use `start` parameter, the server will run in the background and will shut down after tests complete
+If your tests run against a local server, use the `start` parameter to start your server. The server will run in the background.
 
 ```yml
 name: With server
@@ -656,7 +662,7 @@ jobs:
           start: npm start
 ```
 
-**Note:** sometimes on Windows you need to run a different start command. You can use `start-windows` parameter for this
+**Note:** sometimes on Windows you need to run a different start command. You can use the `start-windows` parameter for this.
 
 ```yml
 name: With server
@@ -678,7 +684,7 @@ jobs:
 
 [![start example](https://github.com/cypress-io/github-action/workflows/example-start/badge.svg?branch=master)](.github/workflows/example-start.yml)
 
-**Note:** GitHub cleans up the running server processes automatically. This action does not stop them.
+**Note:** A server continues to run until the end of the GitHub workflow job that started it. At the end of the job the GitHub workflow runner executes a "Complete job" phase automatically where it terminates any server processes which are still running.
 
 ### Start multiple servers
 
@@ -733,6 +739,8 @@ jobs:
 
 [![wait-on example](https://github.com/cypress-io/github-action/workflows/example-wait-on/badge.svg?branch=master)](.github/workflows/example-wait-on.yml)
 
+[![Webpack Dev Server example](https://github.com/cypress-io/github-action/workflows/example-webpack/badge.svg?branch=master)](.github/workflows/example-webpack.yml) (also uses `wait-on`)
+
 By default, `wait-on` will retry for 60 seconds. You can pass a custom timeout in seconds using `wait-on-timeout`.
 
 ```yml
@@ -744,7 +752,7 @@ By default, `wait-on` will retry for 60 seconds. You can pass a custom timeout i
     wait-on-timeout: 120
 ```
 
-See also [![Webpack Dev Server example](https://github.com/cypress-io/github-action/workflows/example-webpack/badge.svg?branch=master)](.github/workflows/example-webpack.yml)
+
 
 You can wait for multiple URLs to respond by separating urls with a comma
 
@@ -760,7 +768,7 @@ You can wait for multiple URLs to respond by separating urls with a comma
 
 The action will wait for the first url to respond, then will check the second url, and so on.
 
-You can even use your own command (usually by using `npm`, `yarn`, `npx`) to wait for the server to respond. For example, if you want to use [wait-on](https://github.com/jeffbski/wait-on) utility to ping the server and run the Cypress tests after the server responds:
+You can even use your own command (usually by using `npm`, `yarn`, `npx`) to wait for the server to respond. For example, if you want to use the [wait-on](https://github.com/jeffbski/wait-on) utility to ping the server and run the Cypress tests after the server responds:
 
 ```yml
 - uses: cypress-io/github-action@v5
@@ -834,7 +842,7 @@ steps:
 
 **Caution**: using the action parameter `command` causes multiple other parameters to be ignored including: `auto-cancel-after-failures`, `browser`, `ci-build-id`, `command-prefix`, `component`, `config`, `config-file`, `env`, `group`, `headed`, `parallel`, `project`, `publish-summary`, `quiet`, `record`, `spec` and `tag`.
 
-See [.github/workflows/example-custom-command.yml](.github/workflows/example-custom-command.yml) file.
+See [example-custom-command.yml](.github/workflows/example-custom-command.yml) file.
 
 ### Custom build id
 
@@ -868,7 +876,7 @@ jobs:
 
 ### Robust custom build id
 
-If you re-run the GitHub workflow, if you use the same custom build id during recording, Cypress Cloud will cancel the run with "Build already finished" error. To avoid this, you need to generate a _new_ custom build id on every workflow re-run. A good solution showing in the [example-custom-ci-build-id.yml](./.github/workflows/example-custom-ci-build-id.yml) file is to run a common job first that just generates a new random ID. This ID can be used by the testing jobs to tie the build together. If the user re-runs the workflow a new unique build id is generated, allowing recording the new Cypress Cloud run.
+If you re-run the GitHub workflow, if you use the same custom build id during recording, Cypress Cloud will cancel the run with "Build already finished" error. To avoid this, you need to generate a _new_ custom build id on every workflow re-run. A good solution showing in the [example-custom-ci-build-id.yml](.github/workflows/example-custom-ci-build-id.yml) file is to run a common job first that just generates a new random ID. This ID can be used by the testing jobs to tie the build together. If the user re-runs the workflow a new unique build id is generated, allowing recording the new Cypress Cloud run.
 
 ```yml
 jobs:
@@ -897,7 +905,7 @@ jobs:
           CYPRESS_RECORD_KEY: ${{ secrets.EXAMPLE_RECORDING_KEY }}
 ```
 
-See the [example-custom-ci-build-id.yml](./.github/workflows/example-custom-ci-build-id.yml) for the full workflow
+See the [example-custom-ci-build-id.yml](.github/workflows/example-custom-ci-build-id.yml) for the full workflow.
 
 ### Working directory
 
@@ -1050,8 +1058,6 @@ jobs:
           working-directory: examples/yarn-classic
 ```
 
-See [example-yarn-classic.yml](.github/workflows/example-yarn-classic.yml) for an example.
-
 [![Yarn classic example](https://github.com/cypress-io/github-action/workflows/example-yarn-classic/badge.svg?branch=master)](.github/workflows/example-yarn-classic.yml)
 
 ### Yarn Modern
@@ -1074,8 +1080,6 @@ jobs:
           install-command: yarn install
 ```
 
-See [example-yarn-modern.yml](.github/workflows/example-yarn-modern.yml) for an example.
-
 [![Yarn Modern example](https://github.com/cypress-io/github-action/workflows/example-yarn-modern/badge.svg?branch=master)](.github/workflows/example-yarn-modern.yml)
 
 ### Yarn Plug'n'Play
@@ -1214,7 +1218,7 @@ jobs:
           working-directory: e2e
 ```
 
-See [cypress-gh-action-monorepo](https://github.com/bahmutov/cypress-gh-action-monorepo) for working example.
+See [cypress-gh-action-monorepo](https://github.com/bahmutov/cypress-gh-action-monorepo) for a working example.
 
 ### Custom install
 
@@ -1238,8 +1242,6 @@ If the project has many dependencies, but you want to install just Cypress you c
     install: false
 ```
 
-See [.github/workflows/example-install-only.yml](.github/workflows/example-install-only.yml) file.
-
 [![Install only Cypress example](https://github.com/cypress-io/github-action/workflows/example-install-only/badge.svg?branch=master)](.github/workflows/example-install-only.yml)
 
 ### Timeouts
@@ -1274,7 +1276,7 @@ See [cypress-gh-action-example](https://github.com/bahmutov/cypress-gh-action-ex
 | [cypress-gh-action-split-install](https://github.com/bahmutov/cypress-gh-action-split-install) (legacy) | Only install npm dependencies, then install and cache Cypress binary yourself             |
 | [cypress-gh-action-changed-files](https://github.com/bahmutov/cypress-gh-action-changed-files) (legacy) | Shows how to run different Cypress projects depending on changed files                    |
 | [cypress-examples](https://github.com/bahmutov/cypress-examples)                                        | Shows separate install job from parallel test jobs                                        |
-| [cypress-gh-action-split-jobs](https://github.com/bahmutov/cypress-gh-action-split-jobs) (legacy)       | Shows a separate install job with the build step, and another job that runs the tests     |
+| [cypress-gh-action-split-jobs](https://github.com/bahmutov/cypress-gh-action-split-jobs)                | Shows a separate install job with the build step, and another job that runs the tests     |
 <!-- prettier-ignore-end -->
 
 ## Notes
@@ -1308,7 +1310,7 @@ You can set the environment variable using GitHub UI interface, or in the workfl
     DEBUG: '@cypress/github-action'
 ```
 
-See the [example-debug.yml](./.github/workflows/example-debug.yml) workflow file.
+See the [example-debug.yml](.github/workflows/example-debug.yml) workflow file.
 
 ### Logs from the test runner
 
@@ -1357,9 +1359,9 @@ 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/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 action sets a GitHub step output `resultsUrl` 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 `resultsUrl` step output is saved.
 
-This is an example of using the step output `dashboardUrl`:
+This is an example of using the step output `resultsUrl`:
 
 ```yml
 - name: Cypress tests
@@ -1377,9 +1379,11 @@ This is an example of using the step output `dashboardUrl`:
 - name: Print Cypress Cloud URL
   run: |
     echo Cypress finished with: ${{ steps.cypress.outcome }}
-    echo See results at ${{ steps.cypress.outputs.dashboardUrl }}
+    echo See results at ${{ steps.cypress.outputs.resultsUrl }}
 ```
 
+The GitHub step output `dashboardUrl` is deprecated. Cypress Dashboard is now [Cypress Cloud](https://on.cypress.io/cloud-introduction).
+
 [![recording example](https://github.com/cypress-io/github-action/workflows/example-recording/badge.svg?branch=master)](.github/workflows/example-recording.yml)
 
 **Note:** every GitHub workflow step can have `outcome` and `conclusion` properties. See the GitHub [Contexts](https://docs.github.com/en/actions/learn-github-actions/contexts) documentation section [steps context](https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#steps-context). In particular, the `outcome` or `conclusion` value can be `success`, `failure`, `cancelled`, or `skipped` which you can use in any following steps.
@@ -1451,8 +1455,6 @@ jobs:
         uses: cypress-io/github-action@v5
 ```
 
-See the [example-cron.yml](./.github/workflows/example-cron.yml) workflow.
-
 [![cron example](https://github.com/cypress-io/github-action/workflows/example-cron/badge.svg?branch=master)](.github/workflows/example-cron.yml)
 
 ### Suppress test summary

package/action.yml

@@ -93,7 +93,9 @@ inputs:
     default: false
 outputs:
   dashboardUrl:
-    description: 'Cypress Dashboard URL if the run was recorded'
+    description: 'Cypress Cloud URL if the run was recorded (deprecated)'
+  resultsUrl:
+    description: 'Cypress Cloud URL if the run was recorded'
 runs:
   using: 'node16'
   main: 'dist/index.js'

package/dist/index.js

@@ -75091,7 +75091,7 @@ const runTests = async () => {
   debug(`Cypress options ${JSON.stringify(cypressOptions)}`)
 
   const onTestsFinished = (testResults) => {
-    const dashboardUrl = testResults.runUrl
+    const resultsUrl = testResults.runUrl
     process.chdir(startWorkingDirectory)
 
     if (testResults.failures) {
@@ -75112,14 +75112,15 @@ const runTests = async () => {
 
     debug(`Cypress tests: ${testResults.totalFailed} failed`)
 
-    if (dashboardUrl) {
-      debug(`Dashboard url ${dashboardUrl}`)
+    if (resultsUrl) {
+      debug(`resultsUrl ${resultsUrl}`)
     } else {
-      debug('There is no Dashboard url')
+      debug('There is no resultsUrl')
     }
 
     // we still set the output explicitly
-    core.setOutput('dashboardUrl', dashboardUrl)
+    core.setOutput('dashboardUrl', resultsUrl) // deprecated and retained for backward compatibility
+    core.setOutput('resultsUrl', resultsUrl) // replacement for dashboardUrl
 
     if (testResults.totalFailed) {
       return Promise.reject(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cypress/github-action",
-  "version": "5.7.2",
+  "version": "5.8.0",
   "description": "GitHub Action for running Cypress end-to-end and component tests",
   "private": false,
   "main": "dist/index.js",
@@ -46,7 +46,7 @@
     "supports-color": "9.3.1"
   },
   "devDependencies": {
-    "@types/node": "18.16.5",
+    "@types/node": "18.16.14",
     "@vercel/ncc": "0.36.1",
     "husky": "8.0.3",
     "markdown-link-check": "3.11.1",