Update README (#33)
This commit is contained in:
19
README.md
19
README.md
@@ -4,7 +4,15 @@
|
|||||||
|
|
||||||
GitHub Action to run `npm audit`
|
GitHub Action to run `npm audit`
|
||||||
|
|
||||||
If vulnerabilities are found by `npm audit`, it creates the following GitHub Issue.
|
## Feature
|
||||||
|
|
||||||
|
### Create a Pull Request comment
|
||||||
|
|
||||||
|
If vulnerabilities are found by `npm audit`, Action triggered by PR creates a comment.
|
||||||
|
|
||||||
|
### Create an Issue
|
||||||
|
|
||||||
|
If vulnerabilities are found by `npm audit`, Action triggered by push, schedule creates the following GitHub Issue.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@@ -28,7 +36,12 @@ N/A
|
|||||||
```yaml
|
```yaml
|
||||||
name: npm audit
|
name: npm audit
|
||||||
|
|
||||||
on: [push, pull_request]
|
on:
|
||||||
|
pull_request:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
- 'releases/*'
|
||||||
# on:
|
# on:
|
||||||
# schedule:
|
# schedule:
|
||||||
# - cron: '0 10 * * *'
|
# - cron: '0 10 * * *'
|
||||||
@@ -41,7 +54,7 @@ jobs:
|
|||||||
- uses: actions/checkout@v1
|
- uses: actions/checkout@v1
|
||||||
- name: install dependencies
|
- name: install dependencies
|
||||||
run: npm ci
|
run: npm ci
|
||||||
- uses: oke-py/npm-audit-action@v1.0.0
|
- uses: oke-py/npm-audit-action@v1.1.0
|
||||||
with:
|
with:
|
||||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
issue_assignees: oke-py
|
issue_assignees: oke-py
|
||||||
|
|||||||
Reference in New Issue
Block a user