What would you like?
If the action is called with a command parameter and other incompatible parameters are also defined, then the action should produce a warning.
Why is this needed?
The command parameter executes a tool command using the GitHub @actions/exec action. This does not call the Cypress Module API, so any parameters that can only be consumed this way are ignored.
The following input parameters are only effective if Cypress Module API is called:
| Action Parameter |
Description |
auto-cancel-after-failures |
Set the failed test threshold for auto cancellation or disable auto cancellation for Cloud recording |
browser |
Select browser that Cypress runs in. A filesystem path to a browser is also allowed. |
component |
Run component tests |
config |
Specify configuration |
config-file |
Specify configuration file |
group |
Group recorded tests together under a single run for Cloud recording |
headed |
Display the browser instead of running headlessly |
parallel |
Run recorded specs in parallel across multiple machines for Cloud recording |
project |
Path to a specific project |
quiet |
Reduce output to stdout |
record |
Record the test run to Cypress Cloud |
spec |
Specify the spec files to run |
tag |
Identify a run with a tag or tags |
publish-summary |
Publish a job summary |
summary-title |
Title for job summary |
Additionally, the command-prefix is not used if the command parameter is defined. This is a consequence of the action logic which checks and executes a defined command parameter before checking for the presence of a command-prefix parameter.
| Action Parameter |
Description |
command-prefix |
converts the Module API call into a CLI call with prefix. |
Users are sometimes misled because there is no warning. Although the README > Custom test command section includes a corresponding caution note, some users overlook this.
Other
The README documentation should be improved to assist users who have previously been calling Cypress with CLI commands, so that it is clear how to migrate to using the Cypress GitHub Action.
What would you like?
If the action is called with a
commandparameter and other incompatible parameters are also defined, then the action should produce a warning.Why is this needed?
The
commandparameter executes a tool command using the GitHub @actions/exec action. This does not call the Cypress Module API, so any parameters that can only be consumed this way are ignored.The following input parameters are only effective if Cypress Module API is called:
auto-cancel-after-failuresbrowsercomponentconfigconfig-filegroupheadedparallelprojectquietstdoutrecordspectagpublish-summarysummary-titleAdditionally, the
command-prefixis not used if thecommandparameter is defined. This is a consequence of the action logic which checks and executes a definedcommandparameter before checking for the presence of acommand-prefixparameter.command-prefixUsers are sometimes misled because there is no warning. Although the README > Custom test command section includes a corresponding caution note, some users overlook this.
Other
The README documentation should be improved to assist users who have previously been calling Cypress with CLI commands, so that it is clear how to migrate to using the Cypress GitHub Action.