diff --git a/npm/git-cliff/package.json b/npm/git-cliff/package.json index e59f2db240..2009ee22c5 100644 --- a/npm/git-cliff/package.json +++ b/npm/git-cliff/package.json @@ -112,5 +112,8 @@ "packageManager": "yarn@4.1.0", "publishConfig": { "access": "public" + }, + "engines": { + "node": ">=18.19 || >=20.6 || >=21" } } diff --git a/website/docs/installation/npm.md b/website/docs/installation/npm.md index 37cc99505e..8a042e6be7 100644 --- a/website/docs/installation/npm.md +++ b/website/docs/installation/npm.md @@ -23,7 +23,7 @@ Afterwards, you can run **git-cliff** via `npm exec git-cliff` or `npx git-cliff **git-cliff** also provides a fully typed programmatic API. You can use it to integrate **git-cliff** into your own tooling. ```typescript -import { runGitCliff, type Options } from 'git-cliff'; +import { runGitCliff, type Options } from "git-cliff"; const options: Options = { // ... @@ -33,3 +33,11 @@ runGitCliff(options); ``` Under the hood this will parse the options, set up the environment and call the **git-cliff** binary for you. + +## Supported Node.js Versions + +The following minimum versions of Node are currently supported: + +- `>=18.19` +- `>=20.6` +- `>=21`