Skip to content

Commit ceb5275

Browse files
authored
Release version 0.4.0. (#37)
Includes a first initial README with a small overview of browsers.
1 parent 7abef7a commit ceb5275

5 files changed

Lines changed: 269 additions & 3186 deletions

File tree

MODULE.bazel

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
module(
44
name = "rules_browsers",
5-
version = "0.3.0",
5+
version = "0.4.0",
66
)
77

88
# Load default browser versions used by targets in `//browsers` for direct consumption. Test rules

MODULE.bazel.lock

Lines changed: 212 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# rules_browsers
2+
3+
Use browsers in Bazel and run tests with them.
4+
5+
## Usage
6+
7+
Add the dependency for `rules_browsers` to your `MODULE.bazel` file.
8+
9+
```starlark
10+
bazel_dep(name = "rules_browsers", version = "0.4.0")
11+
```
12+
13+
This allows you to use provided testing macros. You can also use the
14+
`browser_group` and `browser_toolchain_alias` targets in the browser
15+
directories.
16+
17+
By default, browsers will be used at the _default version_. The default version
18+
is usually the latest version that was available at the time of the used release
19+
of `rules_browsers`. The consequence of this is that upgrading `rules_browsers`
20+
usually means changing the default browser version.
21+
22+
> [!NOTE]
23+
> The default version of browsers can change in any release.
24+
25+
You can manually specify the exact browser version to use for each browser by
26+
providing a version in your own `MODULE.bazel` file. The set of available
27+
versions can be found in `browsers/private/versions/<browser>.bzl`.
28+
29+
```starlark
30+
browsers = use_extension("@rules_browsers//browsers:extensions.bzl", "browsers")
31+
browsers.chrome(version = "x.x.x")
32+
browsers.chromedriver(version = "x.x.x")
33+
browsers.firefox(version = "x.x.x")
34+
```
35+
36+
## Supported Browsers
37+
38+
- Chrome _(`chrome-headless-shell`)_
39+
- Chromedriver
40+
- Firefox
41+
42+
Each browser is provided for the following OS x architecture combinations:
43+
44+
- `linux_x64`
45+
- `macos_x64`
46+
- `macos_arm64`
47+
- `windows_x64`
48+
49+
## Version Policy
50+
51+
This project does not explicitly follow any versioning policy at this time. Any
52+
release may include breaking changes.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "rules_browsers",
3-
"version": "0.3.0",
3+
"version": "0.4.0",
44
"description": "",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)