Resolving comments and making consistent

Author: rhisav-25

.github/workflows/maven-workflow-run.yml

@@ -67,20 +67,14 @@ jobs:
           cd android/testng-examples
           mvn compile
           mvn test -P sample-local-test -D"browserstack.app"="./LocalSample.apk"
-      - name: Run Gradle test for testng Android
+      - name: Run Gradle sample-test for testng Android
         run: |
           cd android/testng-examples
           gradle clean sampleTest
-
-      - name: Run Gradle profile sampleTest for testng Android
-        run: |
-          cd android/testng-examples
-          gradle clean sampleLocalTest
-
-      - name: Run Gradle profile sampleLocalTest for testng Android
+      - name: Run Gradle sampleLocalTest for testng Android
         run: |
           cd android/testng-examples
-           gradle clean sampleLocalTest -Dbrowserstack.app=./LocalSample.apk
+          gradle clean sampleLocalTest -D"browserstack.app"="./LocalSample.apk"
       - name: Run mvn test for testng ios
         run: |
           cd ios/testng-examples
@@ -96,17 +90,11 @@ jobs:
           cd ios/testng-examples
           mvn compile
           mvn test -P sample-local-test -D"browserstack.app"="./LocalSample.ipa"
-      - name: Run Gradle test for testng ios
+      - name: Run Gradle sample-test for testng ios
         run: |
           cd ios/testng-examples
           gradle clean sampleTest
-
-      - name: Run Gradle profile sampleTest for testng ios
-        run: |
-          cd ios/testng-examples
-          gradle clean sampleLocalTest
-
-      - name: Run Gradle profile sampleLocalTest for testng ios
+      - name: Run Gradle sampleLocalTest for testng ios
         run: |
           cd ios/testng-examples
           gradle clean sample-local-test -D"browserstack.app"="./LocalSample.ipa"    

README.md

@@ -14,11 +14,11 @@ This repository demonstrates how to run Appium tests in [TestNG](http://testng.o
         - For Windows, download latest java version from [here](https://java.com/en/download/) and run the installer executable
         - For Mac and Linux, run `java -version` to see what java version is pre-installed. If you want a different version download from [here](https://java.com/en/download/)
 
-2. Maven
+2. Maven (Only required if using Maven as the build tool)
    - If Maven is not downloaded, download it from [here](https://maven.apache.org/download.cgi)
    - For installation, follow the instructions [here](https://maven.apache.org/install.html)
 
-3. Gradle
+3. Gradle (Only required if using Gradle as the build tool)
   - If Gradle is not downloaded, download it from [here](https://gradle.org/releases/)  
   - For installation, follow the instructions [here](https://gradle.org/install/) 
 
@@ -46,16 +46,31 @@ Getting Started with Appium tests in TestNg on BrowserStack couldn't be easier!
 ### **Run Sample test :**
 
 - Switch to one of the following directories: [Android examples](android/testng-examples) or [iOS examples](ios/testng-examples)
-- Run the following maven command `mvn test -P sample-test`
-- Run the following gradle command `gradle clean sampleTest`
+- **For Maven:** Run the following command to execute tests in the Maven environment:  
+    ```sh
+    mvn test -P sample-test
+    ```
+- **For Gradle:** Run the following command to execute tests in the Gradle environment:  
+    ```sh
+    gradle clean sampleTest
+    ```
 
 ### **Use Local testing for apps that access resources hosted in development or testing environments :**
 
 - Simply configure the `browserstackLocal` parameter in the `browserstack.yml` file accordingly in [Android examples](android/testng-examples) or [iOS examples](ios/testng-examples).
   ```
   browserstackLocal: true
   ```
-- You can use the `LocalSample` app provided in both folder [Android examples](android/testng-examples) or [iOS examples](ios/testng-examples) to run your test. Change the app parameter in the `browserstack.yml` file and run the tests with the following command: `mvn test -P sample-local-test`
+- You can use the `LocalSample` app provided in both folder [Android examples](android/testng-examples) or [iOS examples](ios/testng-examples) to run your test. Change the app parameter in the `browserstack.yml` file.
+
+- **For Maven:** Run the following command to execute tests in the Maven environment:  
+    ```sh
+    mvn test -P sample-local-test
+    ```
+- **For Gradle:** Run the following command to execute tests in the Gradle environment:  
+    ```sh
+    gradle clean sampleLocalTest
+    ```
 
 -similarly for gradle you can do :- gradle clean sampleLocalTest
 

android/testng-examples/build.gradle

@@ -44,4 +44,4 @@ task sampleLocalTest(type: Test) {
         suites "src/test/resources/com/browserstack/sample-local-test.testng.xml"
         jvmArgs "-javaagent:${browserstackSDKArtifact.file}"
     }
-}
+}

android/testng-examples/settings.gradle

@@ -13,4 +13,4 @@ pluginManagement {
         }
     }
 }
-rootProject.name = 'testng-browserstack-android'
+rootProject.name = 'testng-browserstack-android'

ios/testng-examples/build.gradle

@@ -44,4 +44,4 @@ task sampleLocalTest(type: Test) {
         suites "src/test/resources/com/browserstack/sample-local-test.testng.xml"
         jvmArgs "-javaagent:${browserstackSDKArtifact.file}"
     }
-}
+}

ios/testng-examples/settings.gradle

@@ -13,4 +13,4 @@ pluginManagement {
         }
     }
 }
-rootProject.name = 'testng-browserstack-ios'
+rootProject.name = 'testng-browserstack-ios'