Add image and example to README.md
This commit is contained in:
27
README.md
27
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.
|
||||
|
||||

|
||||
|
||||
## 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
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user