Skip to content

Commit e2ffd5a

Browse files
authored
docs: add install-command lock file prerequisite (#1310)
1 parent 1f750ad commit e2ffd5a

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -927,7 +927,7 @@ Under Node.js version 18 and later, `wait-on` may fail to recognize that a `loca
927927

928928
### Custom install command
929929

930-
If you want to overwrite the install command
930+
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:
931931

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

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

940+
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`.
941+
940942
### Command prefix
941943

942944
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 --`.

0 commit comments

Comments
 (0)