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.

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

Add Github Action capabilities #11

Merged
merged 9 commits into from
Feb 21, 2023
Merged
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
4 changes: 4 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,7 @@ jobs:
- name: Run validator
run: |
npm run test

- name: Ensure Build
run: |
npm run build
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@ out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
Expand Down
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,25 @@ isNodeVulnerable('19.0.0') // true
```

[Node.js Security Database]: https://github.com/nodejs/security-wg/tree/main/vuln


## Github Action

This package also provide a Github Action, just include the `node-version` in the yml as follows in order to check an specific version:

```yml
name: "Node.js Vulnerabilities"
on:
schedule:
- cron: "0 0 * * *"

jobs:
is-my-node-vulnerable:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Check Node.js
uses: RafaelGSS/is-my-node-vulnerable@v1.2.0
with:
node-version: "18.14.1"
```
16 changes: 16 additions & 0 deletions action.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
const core = require('@actions/core')
const { isNodeVulnerable } = require('./index')

async function run () {
// Inputs
const nodeVersion = core.getInput('node-version', { required: true })
core.info(`Checking Node.js version ${nodeVersion}...`)
const isVulnerable = await isNodeVulnerable(nodeVersion)
if (isVulnerable) {
core.setFailed(`Node.js version ${nodeVersion} is vulnerable. Please upgrade!`)
} else {
core.info(`Node.js version ${nodeVersion} is OK!`)
}
}

run()
18 changes: 18 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: 'is-my-node-vulnerable'
description: 'checks if your Node.js installation is vulnerable to known security vulnerabilities'
author: 'RafaelGSS'

runs:
using: 'node16'
main: 'dist/index.js'

inputs:
node-version:
description: 'Node.js version to check'
required: true
default: '16.13.0'

# https://actions-cool.github.io/github-action-branding/
branding:
icon: 'flag'
color: 'red'
Loading