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.

Sign up for GitHub

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

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

Merged
merged 2 commits into from
Apr 23, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f0d14a
chore(config): Add minimum supported Node versions
lanesawyer Apr 23, 2024
4b9d255
docs(website): polish NPM docs
orhun Apr 23, 2024
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
3 changes: 3 additions & 0 deletions npm/git-cliff/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,5 +112,8 @@
"packageManager": "[email protected]",
"publishConfig": {
"access": "public"
},
"engines": {
"node": ">=18.19 || >=20.6 || >=21"
}
}
10 changes: 9 additions & 1 deletion website/docs/installation/npm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
// ...
Expand All @@ -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`
Loading