Skip to content

Commit 686d18d

Browse files
committed
chore(docs): add install-dependencies to README
1 parent 50190e1 commit 686d18d

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,18 @@ steps:
3131
chrome-version: 120
3232
```
3333

34+
If you use the self-hosted runner, your runner may not have the required dependencies on the system.
35+
You can install the dependencies by using the `install-dependencies` parameter.
36+
It installs the required dependencies for the Google Chrome/Chromium to run automatically.
37+
38+
```yaml
39+
steps:
40+
- uses: browser-actions/setup-chrome@v1
41+
with:
42+
chrome-version: 120
43+
install-dependencies: true
44+
```
45+
3446
### Supported version formats
3547

3648
The action supports the following version formats:
@@ -63,6 +75,8 @@ steps:
6375

6476
- `chrome-version`: *(Optional)* The Google Chrome/Chromium version to be installed.
6577
Default: `latest`
78+
- `install-dependencies`: *(Optional)* Install the required dependencies for the Google Chrome/Chromium to run.
79+
Default: `false`
6680

6781
### Outputs
6882

0 commit comments

Comments
 (0)