Skip to content

docs: add migrate from CLI to README#1444

Merged
jennifer-shehane merged 2 commits into
cypress-io:masterfrom
MikeMcC399:docs/migrate-from-cli-command
Apr 29, 2025
Merged

docs: add migrate from CLI to README#1444
jennifer-shehane merged 2 commits into
cypress-io:masterfrom
MikeMcC399:docs/migrate-from-cli-command

Conversation

@MikeMcC399
Copy link
Copy Markdown
Collaborator

Situation

The action parameter command allows executing a CLI command like npm run e2e:ci.

This example invokes a script defined in the project's package.json and runs it through a CLI call, bypassing the Cypress Module API call.

Users read the documentation section command and understand that this is a good way to use the action, even though the caution node attempts to explain the drawbacks.

Change

Add a "Migrating from CLI command" section

@cypress-app-bot
Copy link
Copy Markdown
Collaborator

@MikeMcC399

This comment was marked as outdated.

@MikeMcC399 MikeMcC399 added the documentation Improvements or additions to documentation label Apr 29, 2025
@MikeMcC399 MikeMcC399 self-assigned this Apr 29, 2025
@MikeMcC399 MikeMcC399 marked this pull request as ready for review April 29, 2025 07:40
Copy link
Copy Markdown
Member

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great to have documented. Thank you!

@MikeMcC399
Copy link
Copy Markdown
Collaborator Author

@jennifer-shehane

This is great to have documented. Thank you!

It should be useful to have this explicitly described. There have been too many users in Discord who have been confused in this area and made the wrong assumptions.

@jennifer-shehane jennifer-shehane merged commit 831a51d into cypress-io:master Apr 29, 2025
74 checks passed
@MikeMcC399 MikeMcC399 deleted the docs/migrate-from-cli-command branch April 29, 2025 15:36
@github-actions
Copy link
Copy Markdown

🎉 This PR is included in version 6.8.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants