Skip to content

feat: Enhance BrowserStack YAML configuration #135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Enhance BrowserStack YAML configuration #135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 28 additions & 3 deletions src/tools/appautomate-utils/appium-sdk/config-generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,21 +46,46 @@ accessKey: ${accessKey}
app: ${appPath}
platforms:
${platformConfigs}

# Parallels per Platform
# Default: 1
parallelsPerPlatform: 1

# Local Testing
# Set to true if you need to test apps with local/staging servers
# Default: false
browserstackLocal: true

# Project and build names help organize your test runs in BrowserStack dashboard and Percy.
# TODO: Replace these sample values with your actual project details
buildName: bstack-demo
projectName: BrowserStack Sample

# Debugging features
# debug: Provides screenshots and logs (Default: true)
# networkLogs: Capture API/network traffic (Default: false)
debug: true
networkLogs: true

# Percy Visual Testing (Default: false)
percy: false
percyCaptureMode: auto

# Accessibility Testing (Default: false)
accessibility: false

# Optional settings (uncomment only if explicitly required)
# geoLocation: "US" # Simulate tests from a specific region
# timezone: "New_York" # Run tests in a custom timezone
# retryOnFailure: 2 # Retries failed tests (Default: 0)
# idleTimeout: 30 # Max idle time in seconds (Default: 30, Range: 0-300)
# commandTimeout: 180 # Max time to wait for a command (Default: 180)
# deviceOrientation: portrait # For mobile, choose portrait or landscape (Default: portrait)
\`\`\`

**Important notes:**
- Replace \`app: ${appPath}\` with the path to your actual app file (e.g., \`./SampleApp.apk\` for Android or \`./SampleApp.ipa\` for iOS)
- You can upload your app using BrowserStack's App Upload API or manually through the dashboard
- Set \`browserstackLocal: true\` if you need to test with local/staging servers
- Replace \`app: ${appPath}\` with the path to your actual app file (e.g., \`./SampleApp.apk\` for Android or \`./SampleApp.ipa\` for iOS).
- You can upload your app using BrowserStack's App Upload API or manually through the dashboard.
- Adjust \`parallelsPerPlatform\` based on your subscription limits`;

// Return formatted step for instructions
Expand Down
10 changes: 9 additions & 1 deletion src/tools/sdk-utils/instructions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,15 @@ browserstackLocal: true
# Debugging features
# ===================
debug: true # Visual logs, text logs, etc.
testObservability: true # For Test Observability`;
testObservability: true # For Test Observability

# Optional settings (uncomment only if explicitly required)
# geoLocation: "US" # Simulate tests from a specific country (Default: null)
# timezone: "New_York" # Run tests in custom timezone
# retryOnFailure: 2 # Retries failed tests (Default: 0)
# idleTimeout: 30 # Max idle time in seconds (Default: 30, Range: 0-300)
# commandTimeout: 180 # Max time to wait for a command (Default: 180)
# deviceOrientation: portrait # For mobile, choose portrait or landscape (Default: portrait)`;

if (enablePercy) {
ymlContent += `
Expand Down