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

[skip ci] docs: sort action inputs alphabetically

Browse Source
This commit is contained in:
Naoki Oketani
2023-01-02 10:23:32 +09:00
parent ad75095d91
commit adbeb47e8f
2 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -23,16 +23,16 @@ If vulnerabilities are found by `npm audit`, Action triggered by push, schedule
|Parameter|Required|Default Value|Description| |Parameter|Required|Default Value|Description|
|:--:|:--:|:--:|:--| |:--:|:--:|:--:|:--|
|audit_level|false|low|The value of `--audit-level` flag| |audit_level|false|low|The value of `--audit-level` flag|
|production_flag|false|false|Runnning `npm audit` with `--omit=dev`| |create_issues|false|true|If 'false', action will not create a new issue even if vulnerabilities are found (since v1.8.0)|
|json_flag|false|false|Runnning `npm audit` with `--json`| |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)|
|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_assignees|false|N/A|Issue assignees (separated by commma)|
|issue_labels|false|N/A|Issue labels (separated by commma)| |issue_labels|false|N/A|Issue labels (separated by commma)|
|issue_title|false|npm audit found vulnerabilities|Issue title| |issue_title|false|npm audit found vulnerabilities|Issue title|
|github_token|true|N/A|GitHub Access Token.<br>${{ secrets.GITHUB_TOKEN }} is recommended.| |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)| |working_directory|false|N/A|The directory which contains package.json (since v1.4.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|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)|
### Outputs ### Outputs

32
action.yml
View File

@@ -6,12 +6,16 @@ inputs:
description: 'The value of `--audit-level` flag' description: 'The value of `--audit-level` flag'
default: low default: low
required: false required: false
production_flag: create_issues:
description: 'Run npm audit with --omit=dev' description: 'Flag to create issues when vulnerabilities are found'
default: 'false' default: 'true'
required: false required: false
json_flag: create_pr_comments:
description: 'Run npm audit with --json' description: 'Flag to create pr comments when vulnerabilities are found'
default: 'true'
required: false
dedupe_issues:
description: 'Flag to de-dupe against open issues'
default: 'false' default: 'false'
required: false required: false
github_context: github_context:
@@ -31,20 +35,16 @@ inputs:
description: 'Issue title' description: 'Issue title'
default: 'npm audit found vulnerabilities' default: 'npm audit found vulnerabilities'
required: false required: false
working_directory: json_flag:
description: 'The directory which contains package.json (since v1.4.0)' description: 'Run npm audit with --json'
required: false
dedupe_issues:
description: 'Flag to de-dupe against open issues'
default: 'false' default: 'false'
required: false required: false
create_issues: production_flag:
description: 'Flag to create issues when vulnerabilities are found' description: 'Run npm audit with --omit=dev'
default: 'true' default: 'false'
required: false required: false
create_pr_comments: working_directory:
description: 'Flag to create pr comments when vulnerabilities are found' description: 'The directory which contains package.json (since v1.4.0)'
default: 'true'
required: false required: false
outputs: outputs:
npm_audit: npm_audit: