Skip to content

Commit dff232f

Browse files
authored
fix: Update README.md
1 parent 067f559 commit dff232f

File tree

1 file changed

+1
-99
lines changed

1 file changed

+1
-99
lines changed

README.md

Lines changed: 1 addition & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -4,102 +4,4 @@
44

55
# setup-chrome
66

7-
This action sets-up Google Chrome/Chromium for GitHub Actions. This action supports the following features:
8-
9-
- Install and setup the Google Chrome onto the runner.
10-
- Install a specific version of Google Chrome/Chromium by the version number, commit position, and release channel.
11-
- Cross-platform runner support (Windows, macOS, Linux) and self-hosted runner support.
12-
- Install the compatible versions of ChromeDriver with the browser.
13-
14-
## Usage
15-
16-
Here is a basic usage.
17-
The action installs the latest build by default.
18-
19-
```yaml
20-
steps:
21-
- uses: browser-actions/setup-chrome@v1
22-
- run: chrome --version
23-
```
24-
25-
To install a specific channel, use `chrome-version` input.
26-
27-
```yaml
28-
steps:
29-
- uses: browser-actions/setup-chrome@v1
30-
with:
31-
chrome-version: 120
32-
```
33-
34-
The action support installing the compatible ChromeDriver with the browser.
35-
You can use the `install-chromedriver` to install the ChromeDriver.
36-
37-
```yaml
38-
steps:
39-
- uses: browser-actions/setup-chrome@v1
40-
with:
41-
chrome-version: 120
42-
install-chromedriver: true
43-
```
44-
45-
If you use the self-hosted runner, your runner may not have the required dependencies on the system.
46-
You can install the dependencies by using the `install-dependencies` parameter.
47-
It installs the required dependencies for the Google Chrome/Chromium to run automatically.
48-
49-
```yaml
50-
steps:
51-
- uses: browser-actions/setup-chrome@v1
52-
with:
53-
chrome-version: 120
54-
install-dependencies: true
55-
```
56-
57-
### Supported version formats
58-
59-
The action supports the following version formats:
60-
61-
- The latest snapshot `latest` (default).
62-
- Commit positions like `1295939`. You can find commit positions from [here][snapshots].
63-
- Google Chrome release channels: `stable`, `beta`, `dev` and `canary`
64-
- Specific versions: `119`, `120.0.6099`, `121.0.6100.0`. The version are resolved by [Chrome for Testing][].
65-
66-
[Chrome for Testing]: https://googlechromelabs.github.io/chrome-for-testing/
67-
68-
### Installed path
69-
70-
The installed binary name is not always `chrome` or `chromium`.
71-
It depends on your installation spec and OS.
72-
73-
To get the installed binary path, use `chrome-path` output of the action:
74-
75-
```yaml
76-
steps:
77-
- uses: browser-actions/setup-chrome@v1
78-
id: setup-chrome
79-
- run: |
80-
${{ steps.setup-chrome.outputs.chrome-path }} --version
81-
```
82-
83-
## Parameters
84-
85-
### Inputs
86-
87-
- `chrome-version`: *(Optional)* The Google Chrome/Chromium version to be installed.
88-
Default: `latest`
89-
- `install-dependencies`: *(Optional)* Install the required dependencies for the Google Chrome/Chromium to run.
90-
Default: `false`
91-
- `install-chromedriver`: *(Optional)* Install the compatible ChromeDriver with the browser.
92-
Default: `false`
93-
94-
### Outputs
95-
96-
- `chrome-path`: The installed Google Chrome/Chromium binary path.
97-
- `chrome-version`: The installed Google Chrome/Chromium version.
98-
- `chromedriver-path`: The installed ChromeDriver binary path.
99-
- `chromedriver-version`: The installed ChromeDriver version.
100-
101-
[snapshots]: https://commondatastorage.googleapis.com/chromium-browser-snapshots/index.html
102-
103-
## License
104-
105-
[MIT](LICENSE)
7+
Update Readme

0 commit comments

Comments
 (0)