From adbeb47e8f3d41e97987a22992dc7f60c114754f Mon Sep 17 00:00:00 2001 From: Naoki Oketani Date: Mon, 2 Jan 2023 10:23:32 +0900 Subject: [PATCH 1/3] [skip ci] docs: sort action inputs alphabetically --- README.md | 12 ++++++------ action.yml | 32 ++++++++++++++++---------------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index dce1713..41a020f 100644 --- a/README.md +++ b/README.md @@ -23,16 +23,16 @@ 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|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)| +|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.| +|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)| -|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 diff --git a/action.yml b/action.yml index 02bdfc4..c3961be 100644 --- a/action.yml +++ b/action.yml @@ -6,12 +6,16 @@ inputs: description: 'The value of `--audit-level` flag' default: low required: false - production_flag: - description: 'Run npm audit with --omit=dev' - default: 'false' + create_issues: + description: 'Flag to create issues when vulnerabilities are found' + default: 'true' required: false - json_flag: - description: 'Run npm audit with --json' + create_pr_comments: + 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: @@ -31,20 +35,16 @@ inputs: 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' + json_flag: + description: 'Run npm audit with --json' default: 'false' required: false - create_issues: - description: 'Flag to create issues when vulnerabilities are found' - default: 'true' + production_flag: + description: 'Run npm audit with --omit=dev' + default: 'false' required: false - create_pr_comments: - description: 'Flag to create pr comments when vulnerabilities are found' - default: 'true' + working_directory: + description: 'The directory which contains package.json (since v1.4.0)' required: false outputs: npm_audit: From 266765b31e63a6dca5dc8c7d20ce4279f6ee3cc8 Mon Sep 17 00:00:00 2001 From: Naoki Oketani Date: Mon, 2 Jan 2023 10:25:02 +0900 Subject: [PATCH 2/3] [skip ci] docs: add missing inputs description --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 41a020f..4fbcf70 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ If vulnerabilities are found by `npm audit`, Action triggered by push, schedule |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)| +|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)| From f18f5f1a2f5bebf4d81f10f9cc8683cd4f856327 Mon Sep 17 00:00:00 2001 From: Naoki Oketani Date: Mon, 2 Jan 2023 10:32:48 +0900 Subject: [PATCH 3/3] [skip ci] docs: update inputs description --- README.md | 12 ++++++------ action.yml | 10 +++++----- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4fbcf70..bd7cd80 100644 --- a/README.md +++ b/README.md @@ -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.
${{ 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 diff --git a/action.yml b/action.yml index c3961be..84eaa10 100644 --- a/action.yml +++ b/action.yml @@ -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: