From f93954e64e292ac787b074ebf8ed49269dd01a1f Mon Sep 17 00:00:00 2001 From: Jibran Haseeb Date: Mon, 9 Oct 2023 23:47:16 +0500 Subject: [PATCH] Updated entrypoint file to remove the default error flag and updated the readme file --- README.md | 18 ++++++++++++++++++ entrypoint.sh | 2 +- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a77c31a..1ef5341 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,24 @@ jobs: with: arguments: -p="./" --ignore="**/.vscode/**, **/*.env, **/.mypy_cache/**, **/tests/**" ``` +By default Horusec returns 0 as error code in any case. This means that your pipeline will not Fail in case of vulnerabilites are found. To change that behaviour you hace to pass the argument -e=true. + +Here is an example of how you can use the flag. + +```yml +on: [push] + +jobs: + checking_code: + runs-on: ubuntu-latest + name: Horusec Scan + steps: + - name: Run Horusec + id: run_horusec + uses: fike/horusec-action@v0.1 + with: + arguments: -e=true -p="./" +``` ## Known Issue diff --git a/entrypoint.sh b/entrypoint.sh index 8fb1b5e..95db87c 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -2,4 +2,4 @@ horusec version -sh -c "horusec start -D -e=true $*" \ No newline at end of file +sh -c "horusec start -D $*" \ No newline at end of file