@wdio/browserstack-service 9.40.0 → 9.41.0

package/build/launcher.d.ts

@@ -18,6 +18,17 @@ export default class BrowserstackLauncherService implements Services.ServiceInst
     private _percyBestPlatformCaps?;
     private readonly browserStackConfig;
     constructor(_options: BrowserstackConfig & BrowserstackOptions, capabilities: Capabilities.TestrunnerCapabilities, _config: Options.Testrunner);
+    /**
+     * SDK-7075: BROWSERSTACK_PROJECT_NAME / BROWSERSTACK_BUILD_NAME take precedence over the
+     * config file, as every other SDK and the binary's own env->config map already do. They are
+     * written back into the caps so the session itself carries them: into bstack:options for W3C
+     * caps (including one this constructor just created), and into the top-level project/build
+     * keys that legacy caps name a build with - added on a BrowserStack session that has no
+     * bstack:options, otherwise only overwritten where already present. Blank values are ignored.
+     * Returns the values applied, for the Test Reporting fields - none for the caps of a
+     * non-BrowserStack session, which are left untouched so the reported names match the session.
+     */
+    private _applyEnvBuildNames;
     onWorkerStart(cid: string, caps: WebdriverIO.Capabilities): Promise<void>;
     onPrepare(config: Options.Testrunner, capabilities: Capabilities.TestrunnerCapabilities | WebdriverIO.Capabilities): Promise<unknown>;
     onComplete(): Promise<unknown>;

package/build/types.d.ts

@@ -38,8 +38,31 @@ export interface TestReportingOptions {
     user?: string;
     key?: string;
 }
+export interface IssueTrackerOptions {
+    /**
+     * Issue tracker the linked issues live in, e.g. 'jira'.
+     */
+    name?: string;
+    /**
+     * Base URL of the issue tracker, e.g. 'https://your-domain.atlassian.net'.
+     */
+    host?: string;
+    [key: string]: unknown;
+}
 export interface TestManagementOptions {
+    /**
+     * Test plan to add this run's test cases to.
+     */
     testPlanId?: string;
+    /**
+     * Issue keys to link to the build, e.g. ['XYZ-1', 'XYZ-2'].
+     */
+    issues?: string[];
+    /**
+     * Issue tracker that `issues` belong to.
+     */
+    issueTracker?: IssueTrackerOptions;
+    [key: string]: unknown;
 }
 export interface RunSmartSelectionOptions {
     enabled?: boolean;
@@ -87,8 +110,14 @@ export interface BrowserstackConfig {
      */
     testReportingOptions?: TestReportingOptions;
     /**
-     * Set the Test Management related config options under this key.
-     * Currently supports testPlanId.
+     * Set the Test Management related config options under this key, e.g. testPlanId, issues
+     * and issueTracker.
+     *
+     * For Mocha and Cucumber runs every key is forwarded to Test Management as is, and the same
+     * JSON object can also be passed through the BROWSERSTACK_TEST_MANAGEMENT_OPTIONS environment
+     * variable or the --browserstack.testManagementOptions CLI argument; each top-level key is
+     * taken from the CLI argument first, then the environment variable, then this option.
+     * Other runs use testPlanId only.
      */
     testManagementOptions?: TestManagementOptions;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/browserstack-service",
-  "version": "9.40.0",
+  "version": "9.41.0",
   "description": "WebdriverIO service for better Browserstack integration",
   "author": "BrowserStack <support@browserstack.com>",
   "homepage": "https://github.com/browserstack/wdio-browserstack-service",