From 5c181bcf2af1f22397c9dfe6e1c7d4e6054fc96d Mon Sep 17 00:00:00 2001 From: Nofar Bluestein Date: Thu, 27 Feb 2025 12:16:41 -0600 Subject: [PATCH 1/2] added TI limitation for location of codebase --- .../use-ci/run-tests/tests-v1/ti-for-csharp.md | 10 ++++++---- .../run-tests/tests-v1/ti-for-java-kotlin-scala.md | 3 +++ .../use-ci/run-tests/tests-v1/ti-for-python.md | 10 ++++++---- .../use-ci/run-tests/tests-v1/ti-for-ruby.md | 4 ++++ .../use-ci/run-tests/tests-v2.md | 7 +++++-- 5 files changed, 24 insertions(+), 10 deletions(-) diff --git a/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-csharp.md b/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-csharp.md index bb88948e0d5..fa575ce9682 100644 --- a/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-csharp.md +++ b/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-csharp.md @@ -19,6 +19,12 @@ Currently, TI (v1) for C# is behind the feature flag `TI_DOTNET`. Contact [Harne ## Enable TI for C# +:::note + +* To use TI for C#, you must use .NET Core or NUnit. +* Test Intelligence requires that the code is cloned into the default workspace directory, `/harness/`. If the code is placed elsewhere, Test Intelligence will not function correctly. + +::: You can enable TI for C# in three steps: @@ -30,11 +36,7 @@ You can enable TI for C# in three steps: Add the **Run Tests** step to the [Build stage](../../set-up-build-infrastructure/ci-stage-settings.md) in a [CI pipeline](../../prep-ci-pipeline-components.md). -:::info - -To use TI for C#, you must use .NET Core or NUnit. -::: You must select **Run only selected tests** (`runOnlySelectedTests: true`) to enable Test Intelligence. For information about each setting, go to [Run Tests step settings](#run-tests-step-settings). diff --git a/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-java-kotlin-scala.md b/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-java-kotlin-scala.md index 83b0cd5b838..e5fd289d223 100644 --- a/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-java-kotlin-scala.md +++ b/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-java-kotlin-scala.md @@ -18,6 +18,9 @@ While **Run Tests** step remains backwards compatible, Harness recommends using ::: ## Enable TI for Java, Kotlin, or Scala +:::note +Test Intelligence requires that the code is cloned into the default workspace directory, `/harness/`. If the code is placed elsewhere, Test Intelligence will not function correctly. +::: You can enable TI for Java, Kotlin, or Scala in three steps: diff --git a/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-python.md b/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-python.md index 3ef8b2b4283..2b4a8a4a918 100644 --- a/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-python.md +++ b/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-python.md @@ -19,6 +19,12 @@ While **Run Tests** step remains backwards compatible, Harness recommends using ## Enable TI for Python +:::note + +* To use TI for Python, your codebase must be Python 3. +* Test Intelligence requires that the code is cloned into the default workspace directory, `/harness/`. If the code is placed elsewhere, Test Intelligence will not function correctly. +::: + You can enable TI for Python in three steps: @@ -30,11 +36,7 @@ You can enable TI for Python in three steps: Add the **Run Tests** step to the [Build stage](../../set-up-build-infrastructure/ci-stage-settings.md) in a [CI pipeline](../../prep-ci-pipeline-components.md). -:::info - -To use TI for Python, your codebase must be Python 3. -::: In the Run Tests step, you must select **Run only selected tests** (`runOnlySelectedTests: true`). For information about each setting, go to [Run Tests step settings](#run-tests-step-settings). diff --git a/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-ruby.md b/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-ruby.md index 5534d9d3a83..54f9f7d5815 100644 --- a/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-ruby.md +++ b/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-ruby.md @@ -20,6 +20,10 @@ While **Run Tests** step remains backwards compatible, Harness recommends using ## Enable TI for Ruby +:::note +Test Intelligence requires that the code is cloned into the default workspace directory, `/harness/`. If the code is placed elsewhere, Test Intelligence will not function correctly. +::: + You can enable TI for Ruby in three steps: 1. [Add a **Run Tests** step.](#add-the-run-tests-step) or use our new [**Test**](../tests-v2.md) diff --git a/docs/continuous-integration/use-ci/run-tests/tests-v2.md b/docs/continuous-integration/use-ci/run-tests/tests-v2.md index 384e9ba1b13..c2ba3c1cef4 100644 --- a/docs/continuous-integration/use-ci/run-tests/tests-v2.md +++ b/docs/continuous-integration/use-ci/run-tests/tests-v2.md @@ -18,9 +18,12 @@ If this feature is not yet enabled in your account, please reach out to [Harness ::: -:::info +:::note + +* To use TI for Python, your codebase must be Python 3. +* Test Intelligence requires that the code is cloned into the default workspace directory, `/harness/`. If the code is placed elsewhere, Test Intelligence will not function correctly. + -To use TI for Python, your codebase must be Python 3. ::: From 3f54750519ba9044d4c291b62c65caecb6dc7134 Mon Sep 17 00:00:00 2001 From: M-Tsur Date: Thu, 27 Feb 2025 23:40:55 -0500 Subject: [PATCH 2/2] Updated text around Python limitations --- .../use-ci/run-tests/tests-v1/ti-for-python.md | 2 +- docs/continuous-integration/use-ci/run-tests/tests-v2.md | 5 +---- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-python.md b/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-python.md index 2b4a8a4a918..d73fb567d56 100644 --- a/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-python.md +++ b/docs/continuous-integration/use-ci/run-tests/tests-v1/ti-for-python.md @@ -21,7 +21,7 @@ While **Run Tests** step remains backwards compatible, Harness recommends using :::note -* To use TI for Python, your codebase must be Python 3. +* To use TI for Python, the image for the step must have Python 3 installed and accessible. Additionally, Virtual Environments for Python (`venv`) are not supported by TI. * Test Intelligence requires that the code is cloned into the default workspace directory, `/harness/`. If the code is placed elsewhere, Test Intelligence will not function correctly. ::: diff --git a/docs/continuous-integration/use-ci/run-tests/tests-v2.md b/docs/continuous-integration/use-ci/run-tests/tests-v2.md index c2ba3c1cef4..f414301b932 100644 --- a/docs/continuous-integration/use-ci/run-tests/tests-v2.md +++ b/docs/continuous-integration/use-ci/run-tests/tests-v2.md @@ -20,14 +20,11 @@ If this feature is not yet enabled in your account, please reach out to [Harness :::note -* To use TI for Python, your codebase must be Python 3. * Test Intelligence requires that the code is cloned into the default workspace directory, `/harness/`. If the code is placed elsewhere, Test Intelligence will not function correctly. - - +* To use TI for Python, the image for the step must have Python 3 installed and accessible. Additionally, Virtual Environments for Python (`venv`) are not supported by TI. ::: - ## Configure the Test step Add the **Test** step to the [Build stage](/docs/continuous-integration/use-ci/set-up-build-infrastructure/ci-stage-settings.md) in a [CI pipeline](/docs/continuous-integration/use-ci/prep-ci-pipeline-components.md).