orhun/git-cliff
1
1
Fork 0
mirror of https://github.com/orhun/git-cliff.git synced 2024-10-26 07:49:41 +03:00
Code Issues Projects Releases Wiki Activity

chore(npm): add minimum supported Node versions (#621)

Browse Source 
* chore(config): Add minimum supported Node versions

* docs(website): polish NPM docs

---------

Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
This commit is contained in:
Lane Sawyer 2024-04-23 11:39:43 -07:00 committed by GitHub
parent d7f685ca20
commit 95bdf2db37
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
npm/git-cliff/package.json
View File

@ -112,5 +112,8 @@
"packageManager": "yarn@4.1.0",
"publishConfig": {
"access": "public"
},
"engines": {
"node": ">=18.19 || >=20.6 || >=21"
}
}

10
website/docs/installation/npm.md
View File

@ -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`