feat: add test results output

.github/workflows/example-recording.yml

@@ -73,6 +73,29 @@ jobs:
           echo Cypress finished with: ${{ steps.cypress.outcome }}
           echo See results at ${{ steps.cypress.outputs.resultsUrl }}
 
+      # print the `runResults` output directly as string
+      - name: Print Cypress run results output
+        run: |
+          echo Cypress run results: ${{ steps.cypress.outputs.runResults }}
+
+      # parse the `runResults` output as JSON.
+      # Note that the output is a string and empty if there is a custom command passed to the action and the command runs through CLI
+      - name: Parse the Cypress run results output
+        uses: actions/github-script@v6
+        with:
+          script: |
+            if (${{ steps.cypress.outputs.runResults }} == "") {
+              console.log('No run results found')
+              return
+            }
+
+            const runResults = JSON.parse('${{ steps.cypress.outputs.runResults }}')
+            console.log("TotalPassed: " + runResults.totalPassed)
+            console.log("TotalFailed: " + runResults.totalFailed)
+            console.log("TotalPending: " + runResults.totalPending)
+            console.log("TotalSkipped: " + runResults.totalSkipped)
+            console.log("TotalDuration: " + runResults.totalDuration) 
+
   group:
     runs-on: ubuntu-22.04
     needs: [check-record-key]

README.md

@@ -1382,6 +1382,23 @@ This is an example of using the step output `resultsUrl`:
 
 The GitHub step output `dashboardUrl` is deprecated. Cypress Dashboard is now [Cypress Cloud](https://on.cypress.io/cloud-introduction).
 
+This action also sets a GitHub step output `runResults` which contains a stringified JSON object.  
+
+This is an example of parsing the `runResults`.  
+
+```yaml
+...
+  steps:
+    - name: Parse run results
+      uses: actions/github-script@v6
+      with:
+        script: |
+          const runResults = JSON.parse('${{ steps.cypress-run.outputs.runResults }}')
+          console.log(runResults.totalPassed)
+          ...
+```
+Structure of the run results object can be found [here](https://docs.cypress.io/guides/guides/module-api#Results).
+
 [![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.

action.yml

@@ -96,6 +96,8 @@ outputs:
     description: 'Cypress Cloud URL if the run was recorded (deprecated)'
   resultsUrl:
     description: 'Cypress Cloud URL if the run was recorded'
+  runResults:
+    description: 'Cypress run results (stringified JSON object)'
 runs:
   using: 'node20'
   main: 'dist/index.js'

dist/index.js

@@ -75212,6 +75212,8 @@ const runTests = async () => {
   debug(`Cypress options ${JSON.stringify(cypressOptions)}`)
 
   const onTestsFinished = (testResults) => {
+    core.setOutput('runResults', testResults)
+
     const resultsUrl = testResults.runUrl
     process.chdir(startWorkingDirectory)
 

index.js

@@ -816,6 +816,8 @@ const runTests = async () => {
   debug(`Cypress options ${JSON.stringify(cypressOptions)}`)
 
   const onTestsFinished = (testResults) => {
+    core.setOutput('runResults', testResults)
+
     const resultsUrl = testResults.runUrl
     process.chdir(startWorkingDirectory)