@cypress/github-action 4.0.0 → 4.1.1

package/README.md

@@ -4,13 +4,12 @@
 
 ## Examples
 
-- [Cypress 10](#cypress-10)
 - [Basic](#basic)
 - [Explicit version](#explicit-version)
 - Run tests in a given [browser](#browser)
   - using [Firefox](#firefox)
   - using [Edge](#edge)
-  - using [headless mode](#headless)
+  - using [headed mode](#headed)
 - Using [Docker image](#docker-image)
 - Specify [environment variables](#env)
 - Run only some [spec files](#specs)
@@ -150,12 +149,12 @@ jobs:
 
 **Note:** Microsoft has not released Edge for Linux yet, thus you need to run these tests on Windows or Mac runners with Edge preinstalled. You can use [`cypress info`](https://on.cypress.io/command-line#cypress-info) command to see the browsers installed on the machine.
 
-### Headless
+### Headed
 
-Run the browser in headless mode
+Run the browser in headed mode - as of Cypress v8.0 the `cypress run` command executes tests in `headless` mode by default
 
 ```yml
-name: Chrome headless
+name: Chrome headed
 on: [push]
 jobs:
   cypress-run:
@@ -165,7 +164,7 @@ jobs:
       - uses: cypress-io/github-action@v4
         with:
           browser: chrome
-          headless: true
+          headed: true
 ```
 
 ### Docker image

package/action.yml

@@ -59,8 +59,8 @@ inputs:
   working-directory:
     description: 'Working directory containing Cypress folder'
     required: false
-  headless:
-    description: 'Whether or not to use headless mode'
+  headed:
+    description: 'Whether or not to use headed mode'
     required: false
   spec:
     description: 'Provide a specific specs to run'

package/dist/index.js

@@ -74623,6 +74623,7 @@ const cliParser = __nccwpck_require__(8604)()
 const findYarnWorkspaceRoot = __nccwpck_require__(6748)
 const debug = __nccwpck_require__(8237)('@cypress/github-action')
 const { ping } = __nccwpck_require__(9390)
+const { SUMMARY_ENV_VAR } = __nccwpck_require__(1327)
 
 /**
  * Parses input command, finds the tool and
@@ -75105,8 +75106,8 @@ const runTestsUsingCommandLine = async () => {
 
   const record = getInputBool('record')
   const parallel = getInputBool('parallel')
-  const headless = getInputBool('headless')
   const component = getInputBool('component')
+  const headed = getInputBool('headed')
 
   // TODO using yarn to run cypress when yarn is used for install
   // split potentially long command?
@@ -75125,8 +75126,8 @@ const runTestsUsingCommandLine = async () => {
   if (component) {
     cmd.push('--component')
   }
-  if (headless) {
-    cmd.push('--headless')
+  if (headed) {
+    cmd.push('--headed')
   }
   if (record) {
     cmd.push('--record')
@@ -75226,7 +75227,7 @@ const runTests = async () => {
   const commandPrefix = core.getInput('command-prefix')
   const customCommand = core.getInput('command')
   const cypressOptions = {
-    headless: getInputBool('headless'),
+    headed: getInputBool('headed'),
     record: getInputBool('record'),
     parallel: getInputBool('parallel'),
     quiet: getInputBool('quiet'),
@@ -75355,9 +75356,55 @@ const runTests = async () => {
   process.chdir(workingDirectory)
   return cypress
     .run(cypressOptions)
+    .then(generateSummary)
     .then(onTestsFinished, onTestsError)
 }
 
+// Summary is not available for GitHub Enterprise at the moment
+const isSummaryEnabled = () => {
+  return process.env[SUMMARY_ENV_VAR] !== undefined
+}
+
+const generateSummary = async (testResults) => {
+  if (!isSummaryEnabled()) {
+    return testResults
+  }
+
+  const headers = [
+    { data: 'Result', header: true },
+    { data: 'Passed :white_check_mark:', header: true },
+    { data: 'Failed :x:', header: true },
+    { data: 'Pending :hand:', header: true },
+    { data: 'Skipped :leftwards_arrow_with_hook:', header: true },
+    { data: 'Duration :clock8:', header: true }
+  ]
+
+  const status =
+    testResults.totalFailed === 0
+      ? 'Passing :white_check_mark:'
+      : 'Failing :red_circle:'
+
+  const summaryRows = [
+    status,
+    `${testResults.totalPassed}`,
+    `${testResults.totalFailed}`,
+    `${testResults.totalPending}`,
+    `${testResults.totalSkipped}`,
+    `${testResults.totalDuration / 1000}s` || ''
+  ]
+
+  await core.summary
+    .addHeading('Cypress Results', 2)
+    .addTable([headers, summaryRows])
+    .addLink(
+      testResults.runUrl ? 'View Run in Dashboard' : '',
+      testResults.runUrl || ''
+    )
+    .write()
+
+  return testResults
+}
+
 const installMaybe = () => {
   const installParameter = getInputBool('install', true)
   if (!installParameter) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cypress/github-action",
-  "version": "4.0.0",
+  "version": "4.1.1",
   "description": "GitHub Action for running Cypress end-to-end tests",
   "private": false,
   "main": "dist/index.js",