nna/npm-audit-action
3
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

[skip ci] docs: update inputs description

Browse Source
This commit is contained in:
Naoki Oketani
2023-01-02 10:32:48 +09:00
parent 266765b31e
commit f18f5f1a2f
2 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -23,17 +23,17 @@ If vulnerabilities are found by `npm audit`, Action triggered by push, schedule
|Parameter|Required|Default Value|Description|
|:--:|:--:|:--:|:--|
|audit_level|false|low|The value of `--audit-level` flag|
|create_issues|false|true|If 'false', action will not create a new issue even if vulnerabilities are found (since v1.8.0)|
|create_pr_comments|false|true|If 'false', action will not create a pr comment even if vulnerabilities are found (since v1.8.0)|
|dedupe_issues|false|false|If 'true', action will not create a new issue when one is already open (since v1.5.0)|
|create_issues|false|true|Flag to create issues when vulnerabilities are found|
|create_pr_comments|false|true|Flag to create pr comments when vulnerabilities are found|
|dedupe_issues|false|false|Flag to de-dupe against open issues|
|github_context|false|`${{ toJson(github) }}`|The `github` context|
|github_token|true|N/A|GitHub Access Token.<br>${{ secrets.GITHUB_TOKEN }} is recommended.|
|issue_assignees|false|N/A|Issue assignees (separated by commma)|
|issue_labels|false|N/A|Issue labels (separated by commma)|
|issue_title|false|npm audit found vulnerabilities|Issue title|
|json_flag|false|false|Runnning `npm audit` with `--json`|
|production_flag|false|false|Runnning `npm audit` with `--omit=dev`|
|working_directory|false|N/A|The directory which contains package.json (since v1.4.0)|
|json_flag|false|false|Run `npm audit` with `--json`|
|production_flag|false|false|Run `npm audit` with `--omit=dev`|
|working_directory|false|N/A|The directory which contains package.json|
### Outputs

10
action.yml
View File

@@ -23,28 +23,28 @@ inputs:
default: ${{ toJson(github) }}
required: false
github_token:
description: 'GitHub access token used to create an issue'
description: 'GitHub Access Token. ${{ secrets.GITHUB_TOKEN }} is recommended.'
required: true
issue_assignees:
description: 'Issue assignees (separated by commma)'
required: false
issue_labels:
description: 'Issue assignees (separated by commma)'
description: 'Issue labels (separated by commma)'
required: false
issue_title:
description: 'Issue title'
default: 'npm audit found vulnerabilities'
required: false
json_flag:
description: 'Run npm audit with --json'
description: 'Run `npm audit` with `--json`'
default: 'false'
required: false
production_flag:
description: 'Run npm audit with --omit=dev'
description: 'Run `npm audit` with `--omit=dev`'
default: 'false'
required: false
working_directory:
description: 'The directory which contains package.json (since v1.4.0)'
description: 'The directory which contains package.json'
required: false
outputs:
npm_audit: