Add documentation for migrating from CLI

[MikeMcC399]

What would you like?

Add a section to the README to detail how to migrate from using Cypress CLI command options to using Cypress GitHub Action parameters.

Why is this needed?

Some users attempt to use the action parameter command as a 1:1 migration step moving from Cypress CLI command options to using Cypress GitHub parameters. In general this is not an optimal way to use the action.

• It by-passes the use of the Cypress Module API
• It ignores many action parameters

The documentation does not provide any specific advice for migration from CLI commands.

Other

Review also other documentation sections for consistency and clarity for related topics.

Related

• Produce action warning if parameters incompatible with command parameter are used #1439

[MikeMcC399]

• This issue is mostly resolved through PR docs: add migrate from CLI to README #1444, however for a complete documentation story feat: validate other parameters against command parameter when used #1445 and test: rework custom test command and example #1447 are needed

[MikeMcC399]

This issue is now resolved through multiple related PRs:

• docs: remove "Specify" from auto-cancel-after-failures section heading #1441
• docs: rework recording instructions with CYPRESS_RECORD_KEY #1443
• docs: add migrate from CLI to README #1444
• feat: validate other parameters against command parameter when used #1445
• test: rework custom test command and example #1447