Skip to content

Commit 913d91a

Browse files
committed
refactor: update BrowserStack SDK setup to use config and improve instruction clarity
1 parent c621255 commit 913d91a

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

src/tools/sdk-utils/commands.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Utility to get the language-dependent prefix command for BrowserStack SDK setup
22
import { SDKSupportedLanguage } from "./types.js";
3-
3+
import config from "../../config.js";
44
// Framework mapping for Java Maven archetype generation
55
const JAVA_FRAMEWORK_MAP: Record<string, string> = {
66
testng: "testng",
@@ -36,7 +36,7 @@ npm i -D browserstack-node-sdk@latest
3636
---STEP---
3737
Run the following command to setup browserstack sdk:
3838
\`\`\`bash
39-
npx setup --username ${process.env.BROWSERSTACK_USERNAME} --key ${process.env.BROWSERSTACK_ACCESS_KEY}
39+
npx setup --username ${config.browserstackUsername} --key ${config.browserstackAccessKey}
4040
\`\`\`
4141
---STEP---
4242
Edit the browserstack.yml file that was created in the project root to add your desired platforms and browsers.`;
@@ -46,12 +46,12 @@ Edit the browserstack.yml file that was created in the project root to add your
4646
const isWindows = process.platform === "win32";
4747

4848
const mavenCommand = isWindows
49-
? `mvn archetype:generate -B -DarchetypeGroupId="com.browserstack" -DarchetypeArtifactId="browserstack-sdk-archetype-integrate" -DarchetypeVersion="1.0" -DgroupId="com.browserstack" -DartifactId="browserstack-sdk-archetype-integrate" -Dversion="1.0" -DBROWSERSTACK_USERNAME="${process.env.BROWSERSTACK_USERNAME}" -DBROWSERSTACK_ACCESS_KEY="${process.env.BROWSERSTACK_ACCESS_KEY}" -DBROWSERSTACK_FRAMEWORK="${mavenFramework}"`
49+
? `mvn archetype:generate -B -DarchetypeGroupId="com.browserstack" -DarchetypeArtifactId="browserstack-sdk-archetype-integrate" -DarchetypeVersion="1.0" -DgroupId="com.browserstack" -DartifactId="browserstack-sdk-archetype-integrate" -Dversion="1.0" -DBROWSERSTACK_USERNAME="${config.browserstackUsername}" -DBROWSERSTACK_ACCESS_KEY="${config.browserstackAccessKey}" -DBROWSERSTACK_FRAMEWORK="${mavenFramework}"`
5050
: `mvn archetype:generate -B -DarchetypeGroupId=com.browserstack \\
5151
-DarchetypeArtifactId=browserstack-sdk-archetype-integrate -DarchetypeVersion=1.0 \\
5252
-DgroupId=com.browserstack -DartifactId=browserstack-sdk-archetype-integrate -Dversion=1.0 \\
53-
-DBROWSERSTACK_USERNAME="${process.env.BROWSERSTACK_USERNAME}" \\
54-
-DBROWSERSTACK_ACCESS_KEY="${process.env.BROWSERSTACK_ACCESS_KEY}" \\
53+
-DBROWSERSTACK_USERNAME="${config.browserstackUsername}" \\
54+
-DBROWSERSTACK_ACCESS_KEY="${config.browserstackAccessKey}" \\
5555
-DBROWSERSTACK_FRAMEWORK="${mavenFramework}"`;
5656

5757
const platformLabel = isWindows ? "Windows" : "macOS/Linux";

src/tools/sdk-utils/constants.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -315,8 +315,8 @@ Here is an example configuration:
315315
\`\`\`javascript
316316
exports.config = {
317317
// Set your BrowserStack credentials
318-
user: process.env.BROWSERSTACK_USERNAME,
319-
key: process.env.BROWSERSTACK_ACCESS_KEY,
318+
user: ${config.browserstackUsername},
319+
key: ${config.browserstackAccessKey},
320320
321321
// Set BrowserStack hostname
322322
hostname: 'hub.browserstack.com',

src/tools/sdk-utils/instructions.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ export function generateBrowserStackYMLInstructions(
4646
# ======================
4747
# BrowserStack Reporting
4848
# ======================
49-
# A single name for your project to organize all your tests. This is required for Percy.
50-
projectName: BrowserStack SDK Tests
51-
# A name for the group of tests you are running
52-
buildName: mcp-run
49+
# Project and build names help organize your test runs in BrowserStack dashboard and Percy.
50+
# TODO: Replace these sample values with your actual project details
51+
projectName: Sample Project
52+
buildName: Sample Build
5353
5454
# =======================================
5555
# Platforms (Browsers / Devices to test)

0 commit comments

Comments
 (0)