Skip to content

Commit

Permalink
refactor: update Node.js semver support matrix
Browse files Browse the repository at this point in the history
BREAKING CHANGE: Drop support for Node.js v10.x

BREAKING CHANGE: Only Node.js LTS releases Codename Erbium (^12.19.0)
and newer are supported. Currently this means ^12.19.0 (Erbium),
^14.15.0 (Fermium), and ^16.13.0 (Gallium).
  • Loading branch information
panva committed Oct 27, 2021
1 parent fc87d2b commit 8b3044e
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 32 deletions.
35 changes: 12 additions & 23 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,24 +38,21 @@ jobs:

test:
name: Node Tests + Coverage
runs-on: ${{ matrix.os }}
runs-on: ubuntu-latest
continue-on-error: ${{ matrix.experimental || false }}
strategy:
fail-fast: false
matrix:
node-version:
- 10.19.0
- 10
- 12.0.0
- 12.19.0
- 12
- 13.7.0
- 13
- 14.2.0
- 14.15.0
- 14
- 15.0.1
- 15
- '>=15'
os:
- ubuntu-latest
- windows-latest
- 16.13.0
- 16
include:
- experimental: true
node-version: '>=17'
steps:
- name: Checkout
uses: actions/checkout@master
Expand Down Expand Up @@ -83,16 +80,8 @@ jobs:
strategy:
matrix:
electron-version:
- 6.0.0
- 6
- 7.0.0
- 7
- 8.0.0
- 8
- 9.0.0
- 9
- 10.0.0
- 10
- 12.0.0
- latest
os:
- ubuntu-latest
- windows-latest
Expand Down
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,9 @@ or koa middlewares. Those can however be built using the exposed API.

## Install

Node.js version **>=12.0.0** is recommended, but **^10.19.0** lts/dubnium is also supported.
Node.js LTS releases Codename Erbium (starting with ^12.19.0) and newer LTS releases are supported.
This means ^12.19.0 (Erbium), ^14.15.0 (Fermium), and ^16.13.0 (Gallium). Future LTS releases will
be added to this list as they're released.

```console
npm install openid-client
Expand Down Expand Up @@ -253,11 +255,6 @@ This will poll in the defined interval and only resolve with a TokenSet once one
will handle the defined `authorization_pending` and `slow_down` "soft" errors and continue polling
but upon any other error it will reject. With tokenSet received you can throw away the handle.

## Electron Support

Electron >=v6.0.0 runtime is supported to the extent of the crypto engine BoringSSL feature parity
with standard Node.js OpenSSL.

## FAQ

#### Semver?
Expand All @@ -269,8 +266,8 @@ private API and is subject to change between any versions.

#### How do I use it outside of Node.js

It is **only built for ^10.19.0 || >=12.0.0 Node.js** environment - including openid-client in
browser-environment targeted projects is not supported and may result in unexpected results.
It is **only built for Node.js** environments - including openid-client in
browser-environment targeted projects is not supported.

#### How to make the client send client_id and client_secret in the body?

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
"timekeeper": "^2.2.0"
},
"engines": {
"node": "^10.19.0 || >=12.0.0 < 13 || >=13.7.0 < 14 || >= 14.2.0"
"node": "^12.19.0 || ^14.15.0 || ^16.13.0"
},
"standard-version": {
"scripts": {
Expand Down

0 comments on commit 8b3044e

Please sign in to comment.