Skip to content

Commit

Permalink
docs: add install-command lock file prerequisite (#1310)
Browse files Browse the repository at this point in the history
  • Loading branch information
MikeMcC399 authored Nov 18, 2024
1 parent 1f750ad commit e2ffd5a
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
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

0 comments on commit e2ffd5a

Please sign in to comment.