docs: rework command-prefix readme section #1451
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This comment was marked as outdated.
This comment was marked as outdated.
jennifer-shehane
approved these changes
May 1, 2025
I only looked at it because of the work I'm doing on the |
|
🎉 This PR is included in version 6.9.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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Situation
The command-prefix parameter
default test commandwithout explaining what the term meansThe example refers to
npmwhereas the action usesnpx.npxrestricts the use of this parameter to package manager setups usingnode_modulesChange
Explain how the action builds the cli command
Say how this is compatible with package managers using a
node_modulesdirectory compatible with npm.Change the Percy link to the re-branded BrowserStack Percy link https://www.browserstack.com/docs/percy/integrate/cypress
Note
There is no live example using
command-prefix. To use percy would require a token to be available and this is not a desirable prerequisite for users forking the repo and expecting all examples to run as-is.