Skip to content

Commit

Permalink
Release v1.7.0 at e82d5ef
Browse files Browse the repository at this point in the history
  • Loading branch information
ueokande committed May 26, 2024
1 parent 9683066 commit c1191dc
Show file tree
Hide file tree
Showing 3 changed files with 652 additions and 278 deletions.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

# setup-chrome

This action sets by Google Chrome/Chromium for use in actions by:
This action sets-up Google Chrome/Chromium for GitHub Actions. This action supports the following features:

- [X] Install and setup latest Chromium
- [X] Cross platform runner (macOS, Linux, Windows)
- [X] Install Google Chrome by channel (stable, beta, dev, and canary)
- [X] Install by version number (88.0.4324, or 88.0)
- Install and setup the Google Chrome onto the runner.
- Install a specific version of Google Chrome/Chromium by the version number, commit position, and release channel.
- Cross-platform runner support (Windows, macOS, Linux) and self-hosted runner support.
- Install the compatible versions of ChromeDriver with the browser.

## Usage

Expand All @@ -31,6 +31,17 @@ steps:
chrome-version: 120
```

The action support installing the compatible ChromeDriver with the browser.
You can use the `install-chromedriver` to install the ChromeDriver.

```yaml
steps:
- uses: browser-actions/setup-chrome@v1
with:
chrome-version: 120
install-chromedriver: true
```

If you use the self-hosted runner, your runner may not have the required dependencies on the system.
You can install the dependencies by using the `install-dependencies` parameter.
It installs the required dependencies for the Google Chrome/Chromium to run automatically.
Expand Down Expand Up @@ -77,11 +88,15 @@ steps:
Default: `latest`
- `install-dependencies`: *(Optional)* Install the required dependencies for the Google Chrome/Chromium to run.
Default: `false`
- `install-chromedriver`: *(Optional)* Install the compatible ChromeDriver with the browser.
Default: `false`

### Outputs

- `chrome-path`: The installed Google Chrome/Chromium binary path.
- `chrome-version`: The installed Google Chrome/Chromium version.
- `chromedriver-path`: The installed ChromeDriver binary path.
- `chromedriver-version`: The installed ChromeDriver version.

[snapshots]: https://commondatastorage.googleapis.com/chromium-browser-snapshots/index.html

Expand Down
8 changes: 8 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ inputs:
description: |-
Install dependent packages for Google Chrome/Chromium (Linux only).
default: false
install-chromedriver:
description: |-
Install the compatible version of ChromeDriver with the installed Google Chrome/Chromium.
default: false
no-sudo:
description: |-
Do not use sudo to install Google Chrome/Chromium (Linux only).
Expand All @@ -20,6 +24,10 @@ outputs:
description: 'The installed Google Chrome/Chromium version. Useful when given a latest version.'
chrome-path:
description: 'The installed Google Chrome/Chromium path.'
chromedriver-version:
description: 'The installed ChromeDriver version. Useful when given a latest version.'
chromedriver-path:
description: 'The installed ChromeDriver path.'
runs:
using: 'node20'
main: 'index.js'
Loading

0 comments on commit c1191dc

Please sign in to comment.