From 527a4604e76afee534bf7e723f4aeba49fca32ba Mon Sep 17 00:00:00 2001 From: Sagi Cohen Date: Sun, 1 Oct 2023 10:12:43 +0300 Subject: [PATCH] Updated flag and documentation --- README.md | 6 +++--- action.yaml | 2 +- entrypoint.sh | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9aebff9..cabeb10 100644 --- a/README.md +++ b/README.md @@ -61,8 +61,8 @@ jobs: | --------------------------- | -------------------- | --------------------------------------------------------------------------------- | ------- | -------- | ------- | | api_token | | Orca API Token used for Authentication | String | Yes | N/A | | project_key | my-project-key | Project Key name | String | Yes | N/A | -| path | sub-dir | Path to scan | String | Yes | N/A | -| format | json | Format for displaying the results | String | No | cli | +| path | sub-dir | Path to scan | String | Yes | . | +| format | json | Format for displaying the results | String | No | table | | output | results/ | Output directory for scan results | String | No | N/A | | no_color | false | Disable color output | Boolean | No | false | | exit_code | 10 | Exit code for failed execution due to policy violations | Integer | No | 3 | @@ -76,7 +76,7 @@ jobs: | show_failed_issues_only | n/a | show only failed issues | Boolean | No | false | | from-commit | n/a | the commit to search *from* | String | No | N/A | | to-commit | n/a | the commit to search *to* | String | No | N/A | -| disable-git-history-scan | true | flag that indicates that the CLI will not scan git history for secrets | Boolean | No | false | +| disable-git-scan | true | flag that indicates that the CLI will not scan git history for secrets | Boolean | No | false | | ignore-git-history-baseline | true | forces a full history scan | Boolean | No | false | diff --git a/action.yaml b/action.yaml index 1d15dfe..54024bd 100644 --- a/action.yaml +++ b/action.yaml @@ -51,7 +51,7 @@ inputs: disable_git_scan: description: "Disable Git scan" required: false - full_history_scan: + ignore_git_history_baseline: description: "run full history scan" required: false from_commit: diff --git a/entrypoint.sh b/entrypoint.sh index 81d66ab..28b50b6 100644 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -104,8 +104,8 @@ function set_secrets_scan_flags() { if [ "${INPUT_TO_COMMIT}" ]; then SCAN_FLAGS+=(--to-commit="${INPUT_TO_COMMIT}") fi - if [ "${INPUT_FULL_HISTORY_SCAN}" ]; then - SCAN_FLAGS+=(--ignore-git-history-baseline="${INPUT_FULL_HISTORY_SCAN}") + if [ "${INPUT_IGNORE_GIT_HISTORY_BASELINE}" ]; then + SCAN_FLAGS+=(--ignore-git-history-baseline="${INPUT_IGNORE_GIT_HISTORY_BASELINE}") fi if [ "${INPUT_DISABLE_GIT_SCAN}" ]; then SCAN_FLAGS+=(--disable-git-scan="${INPUT_DISABLE_GIT_SCAN}")