Skip to content

Commit

Permalink
Bump version to 3.0.0-beta.1
Browse files Browse the repository at this point in the history
  • Loading branch information
sgravrock committed Oct 26, 2024
1 parent 1a9bd43 commit f5f56dc
Show file tree
Hide file tree
Showing 3 changed files with 82 additions and 75 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "jasmine-browser-runner",
"version": "3.0.0-beta.0",
"version": "3.0.0-beta.1",
"description": "Serve and run your Jasmine specs in a browser",
"bin": "bin/jasmine-browser-runner",
"exports": "./index.js",
Expand Down
76 changes: 2 additions & 74 deletions release_notes/3.0.0-beta.0.md
Original file line number Diff line number Diff line change
@@ -1,77 +1,5 @@
# jasmine-browser-runner 3.0.0-beta.0 Release Notes

## Summary

This is a pre-release, intended to offer a preview of breaking changes and to
solicit feedback.

## A Note About Pre-Release Compatibility

There may be additional breaking changes in future 3.0 pre-releases or in the
final 3.0 release. That's allowed by the semver specification, but users are
sometimes unpleasantly surprised by it.

NPM's implementation of carat version ranges assumes that subsequent
pre-releases and final releases are fully compatible with earlier pre-releases.
If your package.json contains `"jasmine-browser-runner": "^3.0.0-beta.0`,
NPM might install any later 3.x version even though there is no guarantee of
compatibility. If that isn't ok, you should specify an exact pre-release version:
`"jasmine-browser-runner": "3.0.0-beta.0`.

If you are publishing a package that depends on jasmine-browser-runner, please
either stick to regular releases or pin to an exact pre-release version.

## Breaking Changes

* Default to localhost when a listenAddress is not specified

Previously, jasmine-browser-runner defaulted to listening on the address
specified by the hostname config value if specified or all network
interfaces if neither listenAddress nor hostname was specified. This
change improves security by not allowing connections from other hosts unless
that's been explicitly requested.

* Removed redundant options parameter from Server#start

If you were passing options to Server#start, pass them to the Server
constructor instead.

* Removed redundant second options parameter from startServer

If you were passing two options parameters to startServer, combine them into
a single parameter.

* Removed legacy Saucelabs support

jasmine-browser-runner can still be used with Saucelabs via the remote
Selenium grid feature. See the README for details.

* Updated to Express 5.0

This may be a breaking change if your jasmine-browser-runner configuration
adds any Express middleware that isn't compatible with Express 5. See the
[Express 5 migration guide](https://expressjs.com/en/guide/migrating-5.html)
for details. If your configuration doesn't contain a `middleware` property,
you don't need to change anything.

## Supported Environments

This version has been tested in the following environments.

| Environment | Supported versions |
|-------------------|-------------------------|
| Node | 18, 20, 22 |
| Safari | 15-17 |
| Chrome | 130* |
| Firefox | 102**, 115**, 128, 131* |
| Edge | 130* |

\* Evergreen browser. Each version of jasmine-browser-runner is tested against
the latest version available at release time.<br>
\** Environments that are past end of life are supported on a best-effort
basis. They may be dropped in a future minor release of Jasmine if continued
support becomes impractical.

jasmine-browser-runner 3.0.0-beta.0 was not released because a documentation bug
was found after the tag was cut but before publishing the release.

------

Expand Down
79 changes: 79 additions & 0 deletions release_notes/3.0.0-beta.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# jasmine-browser-runner 3.0.0-beta.1 Release Notes

## Summary

This is a pre-release, intended to offer a preview of breaking changes and to
solicit feedback.

## A Note About Pre-Release Compatibility

There may be additional breaking changes in future 3.0 pre-releases or in the
final 3.0 release. That's allowed by the semver specification, but users are
sometimes unpleasantly surprised by it.

NPM's implementation of carat version ranges assumes that subsequent
pre-releases and final releases are fully compatible with earlier pre-releases.
If your package.json contains `"jasmine-browser-runner": "^3.0.0-beta.1`,
NPM might install any later 3.x version even though there is no guarantee of
compatibility. If that isn't ok, you should specify an exact pre-release version:
`"jasmine-browser-runner": "3.0.0-beta.1`.

If you are publishing a package that depends on jasmine-browser-runner, please
either stick to regular releases or pin to an exact pre-release version.

## Breaking Changes

* Default to localhost when a listenAddress is not specified

Previously, jasmine-browser-runner defaulted to listening on the address
specified by the hostname config value if specified or all network
interfaces if neither listenAddress nor hostname was specified. This
change improves security by not allowing connections from other hosts unless
that's been explicitly requested.

* Removed redundant options parameter from Server#start

If you were passing options to Server#start, pass them to the Server
constructor instead.

* Removed redundant second options parameter from startServer

If you were passing two options parameters to startServer, combine them into
a single parameter.

* Removed legacy Saucelabs support

jasmine-browser-runner can still be used with Saucelabs via the remote
Selenium grid feature. See the README for details.

* Updated to Express 5.0

This may be a breaking change if your jasmine-browser-runner configuration
adds any Express middleware that isn't compatible with Express 5. See the
[Express 5 migration guide](https://expressjs.com/en/guide/migrating-5.html)
for details. If your configuration doesn't contain a `middleware` property,
you don't need to change anything.

## Supported Environments

This version has been tested in the following environments.

| Environment | Supported versions |
|-------------------|-------------------------|
| Node | 18, 20, 22 |
| Safari | 15-17 |
| Chrome | 130* |
| Firefox | 102**, 115**, 128, 131* |
| Edge | 130* |

\* Evergreen browser. Each version of jasmine-browser-runner is tested against
the latest version available at release time.<br>
\** Environments that are past end of life are supported on a best-effort
basis. They may be dropped in a future minor release of Jasmine if continued
support becomes impractical.


------


_Release Notes generated with _[Anchorman](http://github.com/infews/anchorman)_

0 comments on commit f5f56dc

Please sign in to comment.