From e9a9afd6f9ddd7603977d37b8220121760065491 Mon Sep 17 00:00:00 2001 From: Chenxiong Qi Date: Sat, 2 Nov 2024 17:57:26 +0800 Subject: [PATCH] Update doc link for using snyk in task sast-snyk-check Signed-off-by: Chenxiong Qi --- task/sast-snyk-check-oci-ta/0.3/README.md | 2 +- task/sast-snyk-check-oci-ta/0.3/sast-snyk-check-oci-ta.yaml | 4 ++-- task/sast-snyk-check/0.3/README.md | 2 +- task/sast-snyk-check/0.3/sast-snyk-check.yaml | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/task/sast-snyk-check-oci-ta/0.3/README.md b/task/sast-snyk-check-oci-ta/0.3/README.md index a8d6ae0d0..a712c980c 100644 --- a/task/sast-snyk-check-oci-ta/0.3/README.md +++ b/task/sast-snyk-check-oci-ta/0.3/README.md @@ -2,7 +2,7 @@ Scans source code for security vulnerabilities, including common issues such as SQL injection, cross-site scripting (XSS), and code injection attacks using Snyk Code, a Static Application Security Testing (SAST) tool. -Follow the steps given [here](https://redhat-appstudio.github.io/docs.appstudio.io/Documentation/main/how-to-guides/testing_applications/enable_snyk_check_for_a_product/) to obtain a snyk-token and to enable the snyk task in a Pipeline. +Follow the steps given [here](https://konflux-ci.dev/docs/how-tos/testing/build/snyk/) to obtain a snyk-token and to enable the snyk task in a Pipeline. The snyk binary used in this Task comes from a container image defined in https://github.com/konflux-ci/konflux-test diff --git a/task/sast-snyk-check-oci-ta/0.3/sast-snyk-check-oci-ta.yaml b/task/sast-snyk-check-oci-ta/0.3/sast-snyk-check-oci-ta.yaml index bd004adb6..30615661a 100644 --- a/task/sast-snyk-check-oci-ta/0.3/sast-snyk-check-oci-ta.yaml +++ b/task/sast-snyk-check-oci-ta/0.3/sast-snyk-check-oci-ta.yaml @@ -12,7 +12,7 @@ spec: description: |- Scans source code for security vulnerabilities, including common issues such as SQL injection, cross-site scripting (XSS), and code injection attacks using Snyk Code, a Static Application Security Testing (SAST) tool. - Follow the steps given [here](https://redhat-appstudio.github.io/docs.appstudio.io/Documentation/main/how-to-guides/testing_applications/enable_snyk_check_for_a_product/) to obtain a snyk-token and to enable the snyk task in a Pipeline. + Follow the steps given [here](https://konflux-ci.dev/docs/how-tos/testing/build/snyk/) to obtain a snyk-token and to enable the snyk task in a Pipeline. The snyk binary used in this Task comes from a container image defined in https://github.com/konflux-ci/konflux-test @@ -151,7 +151,7 @@ spec: else # According to shellcheck documentation, the following error can be ignored as it is ignored through indirection: https://www.shellcheck.net/wiki/SC2034 # shellcheck disable=SC2034 - to_enable_snyk='[here](https://redhat-appstudio.github.io/docs.appstudio.io/Documentation/main/how-to-guides/testing_applications/enable_snyk_check_for_a_product/)' + to_enable_snyk='[here](https://konflux-ci.dev/docs/how-tos/testing/build/snyk/)' note="Task $(context.task.name) skipped: If you wish to use the Snyk code SAST task, please create a secret name snyk-secret with the key 'snyk_token' containing the Snyk token by following the steps given ${to_enable_snyk}" TEST_OUTPUT=$(make_result_json -r SKIPPED -t "$note") echo "${TEST_OUTPUT}" | tee "$(results.TEST_OUTPUT.path)" diff --git a/task/sast-snyk-check/0.3/README.md b/task/sast-snyk-check/0.3/README.md index 1813de59b..2cfff803f 100644 --- a/task/sast-snyk-check/0.3/README.md +++ b/task/sast-snyk-check/0.3/README.md @@ -21,7 +21,7 @@ Snyk's SAST tool uses a combination of static analysis and machine learning tech ## How to obtain a snyk-token and enable snyk task on the pipeline: -Follow the steps given [here](https://redhat-appstudio.github.io/docs.appstudio.io/Documentation/main/how-to-guides/testing_applications/enable_snyk_check_for_a_product/) +Follow the steps given [here](https://konflux-ci.dev/docs/how-tos/testing/build/snyk/) ## Results: diff --git a/task/sast-snyk-check/0.3/sast-snyk-check.yaml b/task/sast-snyk-check/0.3/sast-snyk-check.yaml index 7a40fbd9c..f0eec8a21 100644 --- a/task/sast-snyk-check/0.3/sast-snyk-check.yaml +++ b/task/sast-snyk-check/0.3/sast-snyk-check.yaml @@ -11,7 +11,7 @@ spec: description: |- Scans source code for security vulnerabilities, including common issues such as SQL injection, cross-site scripting (XSS), and code injection attacks using Snyk Code, a Static Application Security Testing (SAST) tool. - Follow the steps given [here](https://redhat-appstudio.github.io/docs.appstudio.io/Documentation/main/how-to-guides/testing_applications/enable_snyk_check_for_a_product/) to obtain a snyk-token and to enable the snyk task in a Pipeline. + Follow the steps given [here](https://konflux-ci.dev/docs/how-tos/testing/build/snyk/) to obtain a snyk-token and to enable the snyk task in a Pipeline. The snyk binary used in this Task comes from a container image defined in https://github.com/konflux-ci/konflux-test @@ -129,7 +129,7 @@ spec: else # According to shellcheck documentation, the following error can be ignored as it is ignored through indirection: https://www.shellcheck.net/wiki/SC2034 # shellcheck disable=SC2034 - to_enable_snyk='[here](https://redhat-appstudio.github.io/docs.appstudio.io/Documentation/main/how-to-guides/testing_applications/enable_snyk_check_for_a_product/)' + to_enable_snyk='[here](https://konflux-ci.dev/docs/how-tos/testing/build/snyk/)' note="Task $(context.task.name) skipped: If you wish to use the Snyk code SAST task, please create a secret name snyk-secret with the key 'snyk_token' containing the Snyk token by following the steps given ${to_enable_snyk}" TEST_OUTPUT=$(make_result_json -r SKIPPED -t "$note") echo "${TEST_OUTPUT}" | tee "$(results.TEST_OUTPUT.path)"