diff --git a/README.md b/README.md index dce1713..bd7cd80 100644 --- a/README.md +++ b/README.md @@ -23,16 +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| -|production_flag|false|false|Runnning `npm audit` with `--omit=dev`| -|json_flag|false|false|Runnning `npm audit` with `--json`| +|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.
${{ 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| -|github_token|true|N/A|GitHub Access Token.
${{ secrets.GITHUB_TOKEN }} is recommended.| -|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)| +|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 diff --git a/action.yml b/action.yml index 02bdfc4..84eaa10 100644 --- a/action.yml +++ b/action.yml @@ -6,38 +6,6 @@ inputs: description: 'The value of `--audit-level` flag' default: low required: false - production_flag: - description: 'Run npm audit with --omit=dev' - default: 'false' - required: false - json_flag: - description: 'Run npm audit with --json' - default: 'false' - required: false - github_context: - description: 'The `github` context' - default: ${{ toJson(github) }} - required: false - github_token: - description: 'GitHub access token used to create an issue' - required: true - issue_assignees: - description: 'Issue assignees (separated by commma)' - required: false - issue_labels: - description: 'Issue assignees (separated by commma)' - required: false - issue_title: - description: 'Issue title' - default: 'npm audit found vulnerabilities' - required: false - working_directory: - description: 'The directory which contains package.json (since v1.4.0)' - required: false - dedupe_issues: - description: 'Flag to de-dupe against open issues' - default: 'false' - required: false create_issues: description: 'Flag to create issues when vulnerabilities are found' default: 'true' @@ -46,6 +14,38 @@ inputs: 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' + required: false + github_context: + description: 'The `github` context' + default: ${{ toJson(github) }} + required: false + github_token: + 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 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`' + default: 'false' + required: false + production_flag: + description: 'Run `npm audit` with `--omit=dev`' + default: 'false' + required: false + working_directory: + description: 'The directory which contains package.json' + required: false outputs: npm_audit: description: 'The output of the npm audit report in a text format'