Skip to content
Open
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/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
ci:
uses: rowanmanning/actions/.github/workflows/node-package-single.yml@v3
with:
nodeVersions: '[24, 22, 20]'
nodeVersions: '[24, 22]'
secrets:
githubToken: ${{ secrets.RELEASE_TOKEN }}
npmToken: ${{ secrets.NPM_AUTH_TOKEN }}
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ A well-tested and resilient Node.js parser for [RSS](https://en.wikipedia.org/wi
* [Supported feed formats](#supported-feed-formats)
* [Standards](#standards)
* [Leniency](#leniency)
* [Migration](#migration)
* [Contributing](#contributing)
* [License](#license)
* [Credit](#credit)
Expand All @@ -43,7 +44,7 @@ This is a Node.js-based feed parser for RSS and Atom feeds. The project has the

This library requires the following to run:

* [Node.js](https://nodejs.org/) 20+
* [Node.js](https://nodejs.org/) 22+


## Usage
Expand Down Expand Up @@ -423,6 +424,11 @@ The following XML namespaces are also parsed, and more data will be parsed out f
Feeds in the real world rarely comply strictly with the standards and can sometimes be invalid XML. We try to be as lenient as possible, only throwing errors if no data can be pulled out of the feed. We test against a suite of real-world feeds.


## Migration

A new major version of this project is released if breaking changes are introduced. We maintain a [migration guide](docs/migration.md) to help users migrate between these versions.


## Contributing

[The contributing guide is available here](docs/contributing.md). All contributors must follow [this library's code of conduct](docs/code_of_conduct.md).
Expand Down
21 changes: 21 additions & 0 deletions docs/migration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@

# Migration Guide

This document outlines how to migrate to new major breaking versions of this library. We cover each major version in a separate section.

* [Migrating from v2 to v3](#migrating-from-v2-to-v3)
* [Dropped Node.js v20 support](#dropped-nodejs-v20-support)
* [Migrating from v1 to v2](#migrating-from-v1-to-v2)
* [Dropped Node.js v18 support](#dropped-nodejs-v18-support)

## Migrating from v2 to v3

### Dropped Node.js v20 support

The library now only supports Node.js v22 and above.

## Migrating from v1 to v2

### Dropped Node.js v18 support

The library now only supports Node.js v20 and above.
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 7 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"bugs": "https://github.com/rowanmanning/feed-parser/issues",
"license": "MIT",
"engines": {
"node": "20.x || 22.x || 24.x"
"node": "22.x || 24.x"
},
"scripts": {
"build": "npm run build:types",
Expand Down Expand Up @@ -44,7 +44,12 @@
"testdouble": "^3.16.5",
"typescript": "^5.5.2"
},
"main": "index.js",
"exports": {
".": {
"types": "./index.d.ts",
"default": "./index.js"
}
},
"nyc": {
"reporter": [
"html",
Expand Down