Skip to content

Commit 56301a6

Browse files
Crash0v3rrid3claude
andcommitted
docs(DEVA11Y-657): address @aveek-bs README review
- Title -> "BrowserStack Accessibility DevTools for GitHub"; workflow name -> "BrowserStack Accessibility DevTools". - Learn-more link -> /docs/accessibility-dev-tools/features/remediate-github. - Drop the internal-sounding "BrowserStack runs no AI model…what works today" copy from the intro bullet. - Remove the Service-Account "no user license…Enterprise plan" aside. - Inline the full ready-to-copy workflow in Quick start; drop the separate examples/ link. - Agent hand-off: replace the "what works today" internal note with a generic preview disclaimer, and add the bot allow-list as a prerequisite. - Remove Privacy & security and License sections. - Support -> single https://www.browserstack.com/support link. - examples/: use @main (always latest) instead of @v1; match workflow name. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 6b88408 commit 56301a6

2 files changed

Lines changed: 21 additions & 47 deletions

File tree

README.md

Lines changed: 17 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# BrowserStack Accessibility for GitHub
1+
# BrowserStack Accessibility DevTools for GitHub
22

33
Catch accessibility issues on your pull requests. Comment
44
**`@AccessibilityDevTools`** on a PR and BrowserStack scans the changed code,
@@ -9,12 +9,9 @@ suggestions, and an optional merge check.
99
- 💬 **Results on the PR** — a summary comment and inline, one‑click suggestions.
1010
-**Optional merge gate** — fail the check when accessibility errors are found.
1111
- 🤖 **Optional agent hand‑off (preview)** — the findings comment can `@mention` a PR
12-
agent you already use, which then acts under _your_ credentials. BrowserStack runs no
13-
AI model and never handles your AI keys. **v1 is scan + report**; whether the agent
14-
reviews or fixes is up to that agent (see "Optional: agent hand-off" below for what
15-
works today).
12+
agent you already use, which then acts under _your_ credentials.
1613

17-
Learn more: <https://browserstack.com>
14+
Learn more: <https://www.browserstack.com/docs/accessibility-dev-tools/features/remediate-github>
1815

1916
---
2017

@@ -27,15 +24,12 @@ Learn more: <https://browserstack.com>
2724
- `BROWSERSTACK_USERNAME`
2825
- `BROWSERSTACK_ACCESS_KEY`
2926

30-
A Service Account is a non‑personal, admin‑managed key built for CI — it uses
31-
no user license and can be rotated or revoked independently. (Enterprise plan.)
32-
3327
## Quick start
3428

3529
Add `.github/workflows/browserstack-a11y.yml`:
3630

3731
```yaml
38-
name: BrowserStack Accessibility
32+
name: BrowserStack Accessibility DevTools
3933
on:
4034
issue_comment:
4135
types: [created]
@@ -59,18 +53,20 @@ jobs:
5953
runs-on: ubuntu-latest
6054
timeout-minutes: 15
6155
steps:
62-
# @v1 tracks the latest v1.x; pin to a full commit SHA for supply-chain hardening.
63-
- uses: browserstack/browserstack-accessibility-devtools-action@v1
56+
- uses: browserstack/browserstack-accessibility-devtools-action@main
6457
with:
6558
username: ${{ secrets.BROWSERSTACK_USERNAME }}
6659
access-key: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
6760
comment: true
6861
check-gate: true
6962
fail-on-severity: error
63+
# inline-suggestions: true
64+
# sarif: true
65+
# comment-mode: update
66+
# remediation: true # preview; off by default
67+
# ai-agent: coderabbitai # bare name; the App posts "@coderabbitai"
7068
```
7169

72-
A ready-to-copy version lives at [`examples/browserstack-a11y.yml`](examples/browserstack-a11y.yml).
73-
7470
Then, on any pull request, comment:
7571

7672
```
@@ -124,6 +120,9 @@ Set `remediation: true` and name your agent with `ai-agent`. When findings are
124120
posted, the App `@mentions` that agent on the PR (for example, `@coderabbitai`), and
125121
**your** agent acts under **your** credentials and billing.
126122

123+
**Prerequisite:** if your agent ignores bot authors by default, allow‑list the
124+
**BrowserStack Accessibility** bot in its configuration.
125+
127126
```yaml
128127
with:
129128
username: ${{ secrets.BROWSERSTACK_USERNAME }}
@@ -132,35 +131,10 @@ with:
132131
ai-agent: coderabbitai # BrowserStack posts "@coderabbitai"
133132
```
134133
135-
What works today (honest status — this is a preview, off by default):
136-
137-
- BrowserStack **runs no AI model and never stores your AI credentials.**
138-
- The agent must accept a trigger from a **bot/App** comment.
139-
- **CodeRabbit** — responds to the mention, but produces a **review**, not a fix PR.
140-
- **Claude** (`claude-code-action` / Anthropic Claude GitHub App) — a genuine fix
141-
path, but **not yet reliable** for bot-authored triggers (upstream issues; being
142-
validated). Treat as experimental.
143-
- **GitHub Copilot's coding agent** — **not supported** (it only acts on comments from
144-
a human with write access).
145-
- If your agent ignores bot authors by default, allow‑list the **BrowserStack
146-
Accessibility** bot in its config.
147-
148-
> **v1 is scan + report.** A guaranteed AI-_fix_ path is not part of v1; the hand-off
149-
> above is a preview and is a **silent no-op** if the agent isn't configured to accept it.
150-
151-
## Privacy & security
152-
153-
- Uses a **Service Account** key (not a personal login); store it as an encrypted
154-
Actions secret and rotate via your admin.
155-
- The App's credentials stay on BrowserStack's side — they are **never** placed on
156-
your runner.
157-
- The scan reads only the pull request's changed files.
134+
> This feature is a preview and is off by default. Hand‑off is supported only if
135+
> your AI agent accepts triggers from a bot/App comment; behaviour varies by agent,
136+
> and it is a silent no‑op if the agent isn't configured to accept it.
158137
159138
## Support
160139
161-
- Product & docs: <https://browserstack.com>
162-
- Accessibility API reference (including rate limits): <https://www.browserstack.com/docs/accessibility/api>
163-
164-
## License
165-
166-
[MIT](LICENSE)
140+
- <https://www.browserstack.com/support>

examples/browserstack-a11y.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# Copy this to `.github/workflows/browserstack-a11y.yml` in your repository.
33
#
44
# Trigger: comment `@AccessibilityDevTools` on any pull request.
5-
name: BrowserStack Accessibility
5+
name: BrowserStack Accessibility DevTools
66

77
on:
88
issue_comment:
@@ -32,9 +32,9 @@ jobs:
3232
runs-on: ubuntu-latest
3333
timeout-minutes: 15
3434
steps:
35-
# Use the v1 major tag for automatic patch/minor updates, or pin to a
36-
# full commit SHA for supply-chain hardening (recommended for production).
37-
- uses: browserstack/browserstack-accessibility-devtools-action@v1
35+
# Tracks the latest released Action. Pin to a full commit SHA for
36+
# supply-chain hardening (recommended for production).
37+
- uses: browserstack/browserstack-accessibility-devtools-action@main
3838
with:
3939
username: ${{ secrets.BROWSERSTACK_USERNAME }}
4040
access-key: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}

0 commit comments

Comments
 (0)