@cypress/github-action 6.8.0 → 6.9.0

package/README.md

@@ -931,7 +931,19 @@ If you do not commit a lock file to the repository, you cannot use the action to
 
 ### Command prefix
 
-You can prefix the default test command using the `command-prefix` option. This is useful for example when running [Percy](https://docs.percy.io/docs/cypress), which requires the test command to be wrapped with `percy exec --`.
+You can prefix a test command using the `command-prefix` parameter. This is useful, for example, when running [BrowserStack Percy](https://www.browserstack.com/docs/percy/integrate/cypress), which requires the test command to be prefixed with `percy exec --`. When this parameter is used, the action constructs and executes a CLI command using [npx](https://docs.npmjs.com/cli/v11/commands/npx) in the following form:
+
+```shell
+npx <command-prefix> cypress run <cli run options>
+```
+
+where the `<command-prefix>` is the literal string value from the `command-prefix` parameter and `<cli run options>` are put together from action parameters such as the value of the `browser` parameter. The complete constructed command is shown in the logs. For the example below, this is shown as:
+
+```text
+Cypress test command: npx percy exec -- npx cypress run --browser chrome
+```
+
+Since `command-prefix` is run using `npx`, it is compatible with [npm](https://docs.npmjs.com/cli/v11/) and [Yarn Classic](https://classic.yarnpkg.com/). It may also be used with [pnpm](https://pnpm.io/settings#nodelinker) and [Yarn Modern](https://yarnpkg.com/configuration/yarnrc#nodeLinker) when they are configured for `nodeLinker` compatibility with the `node_modules` directory structure of npm. An alternative to using `command-prefix` is to pass a complete [command](#custom-test-command) parameter instead, including the exact command to be passed to the CLI.
 
 ```yml
 name: Visual
@@ -945,14 +957,12 @@ jobs:
       - name: Cypress run
         uses: cypress-io/github-action@v6
         with:
-          start: npm start
-          # quote the url to be safe against YML parsing surprises
-          wait-on: 'http://localhost:8080'
-          # the entire command will automatically be prefixed with "npm"
-          # and we need the second "npm" to execute "cypress run ..." command line
           command-prefix: 'percy exec -- npx'
+          browser: chrome
 ```
 
+If `command-prefix` is used, then no [job summary](#job-summary-title) is produced, since it runs Cypress with a CLI [cypress run](https://on.cypress.io/app/references/command-line#cypress-run) command instead of using the [Cypress Module API](https://docs.cypress.io/app/references/module-api). The `command` parameter overrides the `command-prefix` parameter, preventing these two parameters from being used together.
+
 ### Custom test command
 
 You can overwrite the Cypress run command with your own command.

package/dist/index.js

@@ -93982,10 +93982,58 @@ const runTestsUsingCommandLine = async () => {
 
   return exec.exec(quote(npxPath), cmd, opts)
 }
+/**
+ * Validate input parameters for consistency when command parameter is used
+ * Output GitHub actions annotation warning if ignored parameters are used
+ */
+const commandIgnoredBooleanInputs = [
+  // parameter name, default value
+  ['component', false],
+  ['headed', false],
+  ['parallel', false],
+  ['quiet', false],
+  ['record', false],
+  ['publish-summary', true]
+]
+const commandIgnoredStringInputs = [
+  'auto-cancel-after-failures',
+  'browser',
+  'ci-build-id',
+  'config',
+  'config-file',
+  'env',
+  'group',
+  'project',
+  'spec',
+  'tag',
+  'command-prefix',
+  'summary-title'
+]
+let ignoredInputParameters = []
+const validateCustomCommand = () => {
+  commandIgnoredBooleanInputs.forEach((input) => {
+    const inputParameter = input[0]
+    const inputDefault = input[1]
+    if (getInputBool(inputParameter) !== inputDefault) {
+      ignoredInputParameters.push(inputParameter)
+    }
+  })
+  commandIgnoredStringInputs.forEach((input) => {
+    if (core.getInput(input)) {
+      ignoredInputParameters.push(input)
+    }
+  })
+  if (ignoredInputParameters.length > 0) {
+    core.warning(
+      `command parameter is used and the following other parameters are ignored: ${ignoredInputParameters.sort().join(', ')}.`
+    )
+  }
+}
 
 /**
  * Run Cypress tests by collecting input parameters
  * and using Cypress module API to run tests.
+ * If command parameter is specified, then run using @actions/exec instead.
  * @see https://on.cypress.io/module-api
  */
 const runTests = async () => {
@@ -94014,6 +94062,7 @@ const runTests = async () => {
 
   if (customCommand) {
     console.log('Using custom test command: %s', customCommand)
+    validateCustomCommand() // catch ignored parameters and output warning
     return execCommand(customCommand, true, 'run tests')
   }
 

package/package.json

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