Skip to content

doc: use latest LTS in the action sample #33

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

Merged
merged 1 commit into from
May 6, 2025
Merged

doc: use latest LTS in the action sample #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ End-of-Life versions don't keep track of recent security releases, therefore, it

## API

This package also exports a function `isNodeVulnerable` to perform the check in runtime
This package also exports a function `isNodeVulnerable` to perform the check at runtime

> [!NOTE]
> The API is only supported on active Node.js versions (v18.x, v20.x, v22.x, v23.x)
Expand All @@ -88,7 +88,7 @@ const { isNodeVulnerable } = require('is-my-node-vulnerable')
isNodeVulnerable('19.0.0') // true
```

Optionally you can define the platform with the argument `platform` to limit the scope. The available platforms are [the same values](https://nodejs.org/api/os.html#osplatform) available in for `os.platform()`.
Optionally, you can define the platform with the argument `platform` to limit the scope. The available platforms are [the same values](https://nodejs.org/api/os.html#osplatform) available in `os.platform()`.

```js
const { isNodeVulnerable } = require('is-my-node-vulnerable')
Expand Down Expand Up @@ -117,16 +117,16 @@ jobs:
- name: Check Node.js
uses: nodejs/is-my-node-vulnerable@v1
with:
node-version: "18.14.1"
node-version: "22.15.0"
```

Optionally you can define the platform with the argument `platform` to limit the scope. The available platforms are [the same values](https://nodejs.org/api/os.html#osplatform) available in for `os.platform()`.
Optionally, you can define the platform with the argument `platform` to limit the scope. The available platforms are [the same values](https://nodejs.org/api/os.html#osplatform) available in `os.platform()`.

```yml
- uses: actions/checkout@v3
- name: Check Node.js
uses: nodejs/is-my-node-vulnerable@v1
with:
node-version: "18.14.1"
node-version: "22.15.0"
platform: "linux"
```