Skip to content

LTS-5452: README step to set credentials as env vars - #8

Merged
SaranshBS merged 5 commits into
mainfrom
LTS-5452-readme-credentials
Nov 6, 2026
Merged

SaranshBS merged 5 commits into
mainfrom
LTS-5452-readme-credentials

Conversation

@MihirR-BS

@MihirR-BS MihirR-BS commented Nov 6, 2026 •

Copy link
Copy Markdown
Collaborator

Adds a Set your credentials step to the README. It covers exporting BROWSERSTACK_USERNAME / BROWSERSTACK_ACCESS_KEY in the shell (macOS/Linux and PowerShell) and never committing them. The CLI reads both from the environment.

Asked for in BrowserStack Security's retest of LTS-5452: the sample READMEs had no step for setting credentials.

JIRA: https://browserstack.atlassian.net/browse/LTS-5452

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added Windows-specific instructions for downloading and running the CLI across the setup guides.
    • Added macOS, Linux, and Windows instructions for setting BrowserStack credentials in the current terminal session, including guidance on keeping credentials out of committed files.
    • Updated test-running and results steps.

Export BROWSERSTACK_USERNAME / BROWSERSTACK_ACCESS_KEY in the shell and
never commit them; the CLI reads them from the environment.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@MihirR-BS
MihirR-BS requested a review from a team as a code owner November 6, 2026 01:13
@MihirR-BS
MihirR-BS requested a review from anupam-s-20 November 6, 2026 01:13
@coderabbitai

coderabbitai Bot commented Nov 6, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The repository documentation now identifies the Windows CLI binary, updates macOS signature checks, explains how to set BrowserStack credentials in macOS/Linux shells and PowerShell, and adds Windows commands for running tests. The ignore rules also exclude browserstack-cli.exe.

Changes: Windows CLI setup

Layer / File(s) Summary
CLI binary and signature setup
.gitignore, README.md, java/README.md, jest/README.md, junit-4/README.md, junit-5/README.md, serenity-cucumber/README.md, testng/README.md
The READMEs identify browserstack-cli.exe as the Windows binary and update the macOS signature verification commands. .gitignore excludes files with that name at any directory depth.
Credential setup
README.md, java/README.md, jest/README.md, junit-4/README.md, junit-5/README.md, serenity-cucumber/README.md, testng/README.md
The READMEs document shell-specific commands for setting BrowserStack credentials. They note that the variables last for the current terminal session and warn against committing or exposing credentials.
CLI test commands
README.md, java/README.md, jest/README.md, junit-4/README.md, junit-5/README.md, serenity-cucumber/README.md, testng/README.md
The READMEs add Windows PowerShell commands to run the CLI and update the run and results step numbering.

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Merge Risk: Minimal · up to 082fb

The setup documentation has no identified merge-blocking issues.

Architecture risk: Low · up to 082fb

The change affects 7 systems.

Changed systems: java, jest, junit-4, junit-5, README.md, serenity-cucumber, testng

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — java (service) was modified; 1 changed file maps to changed impact.
  • observed — jest (service) was modified; 1 changed file maps to changed impact.
  • observed — junit-4 (service) was modified; 1 changed file maps to changed impact.
  • observed — junit-5 (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in README.md: The extraction instructions now identify browserstack-cli.exe as the Windows binary name.
  • observed — Modified behavior in README.md: The macOS signing check now requires successful strict verification against the Apple generic anchor and BrowserStack team ID YQ5FZQ855D; it replaces the prior command that inspected output for TeamIdentifier=YQ5FZQ855D.
  • observed — Modified behavior in README.md: Adds instructions for setting the username and access key in macOS/Linux or PowerShell, prompting for the key without echoing it. The variables are documented as session-scoped, with guidance for authentication errors and warnings not to commit credentials; the YAML placeholders remain, with environment variables stated to override them.
  • observed — Modified behavior in README.md: The run step is renumbered from 6 to 7 and adds a PowerShell command using browserstack-cli.exe; the results step is renumbered from 7 to 8.
Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly describes the main change: adding README instructions to set credentials as environment variables.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

A rabbit checks the shell commands with care,
Then hops to Windows, CLI.exe in the air.
A hidden key stays out of sight,
The steps now guide each test aright.
The README trail is clear to see,
And bunny bounds with glee!

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Central YAML (base), Organization UI (inherited), Workspace UI (inherited); Enforced overrides: Organization
  • Review profile: ASSERTIVE
  • Plan: Enterprise
  • Run ID: e3d51322-fa1e-468e-8dfe-2ff79fa9cbcd
Commits

Reviewing files that changed from the base of the PR and between a9d5ff4 and 082fb74.

Files selected for processing: 7

  • README.md
  • java/README.md
  • jest/README.md
  • junit-4/README.md
  • junit-5/README.md
  • serenity-cucumber/README.md
  • testng/README.md

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 6 remain after this review.

Recent review details

Additional comments: 7

README.md: 1

48-48: LGTM!

Also applies to: 54-54, 57-57

java/README.md: 1

42-42: LGTM!

Also applies to: 48-48, 51-51

jest/README.md: 1

42-42: LGTM!

Also applies to: 48-48, 51-51

junit-4/README.md: 1

42-42: LGTM!

Also applies to: 48-48, 51-51

junit-5/README.md: 1

42-42: LGTM!

Also applies to: 48-48, 51-51

serenity-cucumber/README.md: 1

42-42: LGTM!

Also applies to: 48-48, 51-51

testng/README.md: 1

42-42: LGTM!

Also applies to: 48-48, 51-51

@MihirR-BS

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Hidden prompt for the access key so it stays out of bash/zsh and
PSReadLine history (CodeRabbit); note the variables last for the current
session and how to spot an unset one; per-repo fixes from the code review.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@MihirR-BS

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Action not completed

Review rate limited.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@MihirR-BS

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Action not completed

Review rate limited.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

MihirR-BS and others added 2 commits November 6, 2026 07:32
Prompt and export on one line, so pasting the block can't feed the export line to read. Robot: per-OS signature check, .gitignore for the CLI binary. Selenium: ignore browserstack-cli.exe.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
zsh (macOS default) has interactive_comments off, so pasted '#' lines printed errors; the labels now sit outside the sh fences. The placement note names browserstack-cli.exe for Windows.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@MihirR-BS

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

codesign -dv's TeamIdentifier can be forged on an ad hoc signature; require an Apple-anchored leaf cert with OU YQ5FZQ855D instead (checked against the current macOS arm64 build: passes; a wrong OU fails). Add chmod +x after unzip (CodeRabbit).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@MihirR-BS

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@SaranshBS
SaranshBS merged commit d6926fd into main Nov 6, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants