Merge pull request #84 from karanshah-browserstack/update_build_identifier

Update build Identifier and yml comments

Author: kamal-kaur04

browserstack.yml

@@ -1,25 +1,27 @@
 # =============================
 # Set BrowserStack Credentials
 # =============================
-# Add your BrowserStack userName and acccessKey here or set BROWSERSTACK_USERNAME and
+# Add your BrowserStack userName and accessKey here or set BROWSERSTACK_USERNAME and
 # BROWSERSTACK_ACCESS_KEY as env variables
 userName: YOUR_USERNAME
 accessKey: YOUR_ACCESS_KEY
 
 # ======================
-# Organizing your tests
+# BrowserStack Reporting
 # ======================
-# Use `projectName`, `buildName`, `name` capabilities to organise your tests
-# `name` is the name of your test sessions and is automatically picked from your
-# test name and doesn't need to be set manually when using BrowserStack SDK
-# `buildName` is used to name your CI/CD job or the execution of your test suite.
-# Ensure you add a dynamic identifier, like an incremental build number from your
-# CI/CD or timestamp at the end of every build; otherwise tests from different
-# executions will be grouped together on BrowserStack
-buildName: browserstack-build-1
-# Use `projectName` to set the name of your project. Example, Marketing Website
-projectName: BrowserStack Samples
-# Use `framework` to set the framework of your project. Example, testng, cucumber, cucumber-testng
+# The following capabilities are used to set up reporting on BrowserStack:
+# Set 'projectName' to the name of your project. Example, Marketing Website
+projectName: BrowserStack Samples 
+# Set `buildName` as the name of the job / testsuite being run
+buildName: browserstack build 
+# `buildIdentifier` is a unique id to differentiate every execution that gets appended to
+# buildName. Choose your buildIdentifier format from the available expressions:
+# ${BUILD_NUMBER} (Default): Generates an incremental counter with every execution
+# ${DATE_TIME}: Generates a Timestamp with every execution. Eg. 05-Nov-19:30
+# Read more about buildIdentifiers here -> https://www.browserstack.com/docs/automate/selenium/organize-tests
+buildIdentifier: '#${BUILD_NUMBER}' # Supports strings along with either/both ${expression}
+# Set `framework` of your test suite. Example, `testng`, `cucumber`, `cucumber-testng`
+# This property is needed to send test context to BrowserStack (test name, status)
 framework: testng
 
 # =======================================
@@ -36,10 +38,10 @@ platforms:
     osVersion: 10
     browserName: Edge
     browserVersion: latest
-  - device: Samsung Galaxy S22 Ultra
+  - deviceName: Samsung Galaxy S22 Ultra
     browserName: chrome # Try 'samsung' for Samsung browser
     osVersion: 12.0
-
+    
 # =======================
 # Parallels per Platform
 # =======================
@@ -60,12 +62,13 @@ source: testng:sample-master:v1.1
 # Set browserStackLocal to true if your website under test is not accessible publicly over the internet
 # Learn more about how BrowserStack Local works here -> https://www.browserstack.com/docs/automate/selenium/local-testing-introduction
 browserstackLocal: true # <boolean> (Default false)
-  #browserStackLocalOptions:
-# Options to be passed to BrowserStack local in-case of advanced configurations
-#  localIdentifier: # <string> (Default: null) Needed if you need to run multiple instances of local.
-#  forceLocal: true  # <boolean> (Default: false) Set to true if you need to resolve all your traffic via BrowserStack Local tunnel.
-# Entire list of arguments available here -> https://www.browserstack.com/docs/automate/selenium/manage-incoming-connections
 
+# Options to be passed to BrowserStack local in-case of advanced configurations
+# browserStackLocalOptions:
+  # localIdentifier: # <string> (Default: null) Needed if you need to run multiple instances of local.
+  # forceLocal: true  # <boolean> (Default: false) Set to true if you need to resolve all your traffic via BrowserStack Local tunnel.
+  # Entire list of arguments available here -> https://www.browserstack.com/docs/automate/selenium/manage-incoming-connections
+  
 # ===================
 # Debugging features
 # ===================