From 683666665c42cfbb14661719340f96918472d8c6 Mon Sep 17 00:00:00 2001 From: Danyal Aytekin Date: Tue, 26 Mar 2024 19:37:25 +0000 Subject: [PATCH] Release `pa11y-webservice-client-node@4` (#24) * Major version to `4.0.0` from `3.0.0` * Add custom badge to show `pa11y-webservice` API support * Update support table * Update migration guide * Add `CHANGELOG.md` and an entry for `4.0.0` --- CHANGELOG.md | 21 +++++++++++++++++++++ MIGRATION.md | 6 +++--- README.md | 7 ++++++- package-lock.json | 4 ++-- package.json | 2 +- 5 files changed, 33 insertions(+), 7 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..52eeeb3 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,21 @@ +# Changelog + +For versions below `4.0.0`, see the project's [tags](https://github.com/pa11y/pa11y-webservice-client-node/tags) on GitHub. + +## 4.0.0 + +### Changes + +* **Major:** Require Node.js `18-20`, up from `12-16` +* **Major:** `pa11y-webservice@4` is now unambiguously licensed as `LGPL-3.0-only` +* **Major:** Update support policy +* Improve project verification and publishing + +### New contributors + +* @danyalaytekin made their first contribution in https://github.com/pa11y/pa11y-webservice-client-node/pull/19 + +### Full diff + +[3.0.0...4.0.0](https://github.com/pa11y/pa11y-webservice-client-node/compare/3.0.0...4.0.0) + diff --git a/MIGRATION.md b/MIGRATION.md index b81f885..10bbe70 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -4,12 +4,12 @@ This package's API and/or supported set of environments changes between major ve ## Migrating to 4 from 3 -1. Upgrade to Node.js 18 or above. +1. Upgrade to Node.js 18 or 20. ## Migrating to 3 from 2 -1. Upgrade to Node.js 12 or above. +1. Upgrade to Node.js 12, 14, or 16. ## Migrating to 2 from 1 -1. Upgrade to Node.js 8 or above. +1. Upgrade to Node.js 8 or 10. diff --git a/README.md b/README.md index f23258c..74d330f 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ This is a Node.js client library for [Pa11y Webservice][pa11y-webservice]. [![Latest version published to npm][shield-npm]][info-npm] [![Node.js version support][shield-node]][info-node] +[![Supports pa11y-webservice@4 API][shield-api]][pa11y-webservice] [![Build status][shield-build]][info-build] [![LGPL-3.0 licensed][shield-license]][info-license] @@ -184,7 +185,8 @@ The following table lists the major versions available and, for each previous ma | Major version | Final minor version | Node.js support | Support end date | | :-------------- | :------------------ | :----------------------- | :--------------- | -| `3` | | `>= 12` | ✅ Current major version | +| `4` | | `18`, `20` | ✅ Current major version | +| `3` | `3.0` | `12`, `14`, `16` | September 2024 | | `2` | `2.0` | `8`, `10` | 2022-05-26 | | `1` | `1.2` | `0.10`, `0.12`, `4`, `6` | 2020-01-05 | @@ -195,11 +197,14 @@ Copyright © 2013-2024, Team Pa11y [pa11y-webservice]: https://github.com/pa11y/pa11y-webservice [wiki-web-service]: https://github.com/pa11y/pa11y-webservice/wiki/Web-Service-Endpoints + [info-build]: https://github.com/pa11y/pa11y-webservice-client-node/actions/workflows/tests.yml [info-license]: LICENSE [info-node]: package.json [info-npm]: https://www.npmjs.com/package/pa11y-webservice-client-node + [shield-build]: https://github.com/pa11y/pa11y-webservice-client-node/actions/workflows/tests.yml/badge.svg [shield-license]: https://img.shields.io/badge/license-LGPL%203.0-blue.svg [shield-node]: https://img.shields.io/node/v/pa11y-webservice-client-node.svg [shield-npm]: https://img.shields.io/npm/v/pa11y-webservice-client-node.svg +[shield-api]: https://img.shields.io/badge/api-pa11y--webservice@4-blue.svg diff --git a/package-lock.json b/package-lock.json index dddfa52..c9fb09d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "pa11y-webservice-client-node", - "version": "3.0.0", + "version": "4.0.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "pa11y-webservice-client-node", - "version": "3.0.0", + "version": "4.0.0", "license": "LGPL-3.0-only", "dependencies": { "request": "~2.88.2" diff --git a/package.json b/package.json index cb0606d..534c95d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "pa11y-webservice-client-node", - "version": "3.0.0", + "version": "4.0.0", "engines": { "node": ">=18" },