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 `testResults` output directly as string
+      - name: Print Cypress test results output
+        run: |
+          echo Cypress test results: ${{ steps.cypress.outputs.testResults }}
+
+      # parse the `testResults` 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 test results output
+        uses: actions/github-script@v6.4.1
+        with:
+          script: |
+            if (${{ steps.cypress.outputs.testResults }} == "") {
+              console.log('No test results found')
+              return
+            }
+
+            const testResults = JSON.parse('${{ steps.cypress.outputs.testResults }}')
+            console.log("TotalPassed: " + testResults.totalPassed)
+            console.log("TotalFailed: " + testResults.totalFailed)
+            console.log("TotalPending: " + testResults.totalPending)
+            console.log("TotalSkipped: " + testResults.totalSkipped)
+            console.log("TotalDuration: " + testResults.totalDuration) 
+
   group:
     runs-on: ubuntu-22.04
     needs: [check-record-key]

README.md

@@ -1374,6 +1374,22 @@ The GitHub step output `dashboardUrl` is deprecated. Cypress Dashboard is now [C
 
 **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.
 
+It also sets a step output `testResults` which contains a stringified test results JSON object.  
+In order to use it you should parse the string into an object.  
+Ex:
+```yaml
+...
+  steps:
+    - name: Parse results
+      uses: actions/github-script@v6.4.1
+      with:
+        script: |
+          const testResults = JSON.parse('${{ steps.cypress-run.outputs.testResults }}')
+          console.log(testResults.totalPassed)
+          ...
+```
+Structure of the test results object can be found [here](https://docs.cypress.io/guides/guides/module-api#Results).
+
 ### Print Cypress info
 
 Sometimes you might want to print Cypress and OS information, like the list of detected browsers. You can use the [`cypress info`](https://on.cypress.io/command-line#cypress-info) command for this.

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'
+  testResults:
+    description: 'Cypress test results stringifyed JSON object'
 runs:
   using: 'node20'
   main: 'dist/index.js'