diff --git a/README.md b/README.md index eb12da4..11fc31a 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ GitHub Action to run `npm audit` +If vulnerabilities are found by `npm audit`, it creates the following GitHub Issue. + +![image](https://github.com/oke-py/npm-audit-action/blob/master/issue.png) + ## Usage ### Inputs @@ -19,4 +23,25 @@ N/A ## Example Workflow -TBD +```yaml +name: npm audit + +on: [push, pull_request] +# on: +# schedule: +# - cron: '0 10 * * *' + +jobs: + scan: + name: npm audit + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - name: install dependencies + run: npm ci + - uses: oke-py/npm-audit-action@v0.1.0 + with: + token: ${{ secrets.GITHUB_TOKEN }} + issue_assignees: oke-py + issue_labels: vulnerability,test +``` diff --git a/issue.png b/issue.png new file mode 100644 index 0000000..96f4436 Binary files /dev/null and b/issue.png differ