Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add install-command lock file prerequisite #1310

Merged
merged 2 commits into from
Nov 18, 2024
Merged

docs: add install-command lock file prerequisite #1310

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d788228
docs: add install-command lock file prerequisite
MikeMcC399 Nov 16, 2024
5dfb84b
Merge branch 'master' into docs/install-command
MikeMcC399 Nov 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -927,7 +927,7 @@ Under Node.js version 18 and later, `wait-on` may fail to recognize that a `loca

### Custom install command

If you want to overwrite the install command
The action installs dependencies based on a package manager lock file using default commands described in the [Installation](#installation) section below. If you want to overwrite the default install command you can use the `install-command` option:

```yml
- uses: cypress-io/github-action@v6
Expand All @@ -937,6 +937,8 @@ If you want to overwrite the install command

See [example-install-command.yml](.github/workflows/example-install-command.yml) workflow file.

If you do not commit a lock file to the repository, you cannot use the action to install dependencies. In this case you must ensure that dependencies are installed before using the action, and you must use the action option setting `install: false`.

### 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 --`.
Expand Down