Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat!: Drop support node version below 12 and fix vulnerabilities #802

Merged
merged 4 commits into from
Feb 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build_and_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node: ['8', '10', '12', '14', '16']
node: ['12', '14', '16']
name: Node ${{ matrix.node }}
steps:
- name: Checkout
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/integration-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: 12
node-version: 14
cache: 'npm'
- name: Install dependencies
run: npm install
Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Box Node.js SDK
===============

[![Greenkeeper badge](https://badges.greenkeeper.io/box/box-node-sdk.svg)](https://greenkeeper.io/)
![Platform](https://img.shields.io/badge/node-8--14-blue)
![Platform](https://img.shields.io/badge/node-12--16-blue)
[![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)
[![Coverage](https://coveralls.io/repos/github/box/box-node-sdk/badge.svg?branch=main)](https://coveralls.io/github/box/box-node-sdk?branch=main)

Expand Down Expand Up @@ -237,7 +237,7 @@ We highly recommend upgrading to the latest SDK major release at the earliest co

| Version | Supported Environments | State | First Release | EOL/Terminated |
|---------|------------------------|-----------|---------------|----------------|
| 2 | Node.js >= 8 and <= 14 | Supported | 29 Sep 2021 | TBD |
| 2 | Node.js >= 12 and <= 16| Supported | 29 Sep 2021 | TBD |
| 1 | | EOL | 28 Mar 2019 | 29 Sep 2021 |

## Questions, Bugs, and Feature Requests?
Expand Down Expand Up @@ -267,6 +267,10 @@ For more information, please see [the Contribution guidelines](./CONTRIBUTING.md

See [CHANGELOG.md](./CHANGELOG.md).

## Upgrades

You can read about how to migrate to the new version [here](./docs/upgrade/).

## Documentation

You can find guides and tutorials in the `docs` directory.
Expand Down
23 changes: 23 additions & 0 deletions docs/upgrade/2.x.x to 3.x.x.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Migration guide for versions 2.x.x -> 3.x.x

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->



<!-- END doctoc generated TOC please keep comment here to allow auto update -->


This release contains a number of changes. The most notable are:
- Drop support for Node versions below 12.
- Bump `jsonwebtoken` to version 9.0.0.

## Runtime requirements

From this version, we will only support Node versions 12 and above. This is due to the fact that `jsonwebtoken` version 9.0.0 dropped support for Node versions below 12. If you are using an older version of Node, you will need to upgrade to a newer version.

## Dependencies

### `jsonwebtoken`

We have bumped the version of `jsonwebtoken` to 9.0.0 to fix a security vulnerability. If you are using `jsonwebtoken` directly, you will need to upgrade to version 9.0.0 to avoid conflicts.
Loading