Install with a pull request
Last updated
Whisperr can add its SDK and your events to your code for you, through a GitHub pull request. Use this path if your code is on GitHub and you do not want to run a coding agent yourself. For the other ways to install, see Install with your coding agent and Install with the CLI wizard.
A workspace owner or admin does these steps.
Connect GitHub
Section titled “Connect GitHub”In the Whisperr dashboard, open Integrations → Your code → GitHub and click Connect GitHub. On a new app, the setup on Home offers the same path as Pull request agent with Install the GitHub app.
GitHub opens the installation page of the Whisperr GitHub App. Choose the account and the repositories that the app may read. Then GitHub sends you back to Whisperr.
If the repositories belong to a GitHub organization, an organization owner may have to approve the app first. Whisperr shows “GitHub is waiting for an organization owner to approve the Whisperr app.” Come back after the approval.
Pick the repositories
Section titled “Pick the repositories”Click Open a pull request. Whisperr lists the repositories that you shared with the app. Pick the repositories that hold your app code, then click Open pull request (Open 2 pull requests and so on when you pick several). Whisperr opens one pull request per repository, up to 10 at a time.
If a repository is missing, click Choose repositories on GitHub, give the app access to it, and click Refresh or the refresh icon.
Review the pull request
Section titled “Review the pull request”For each repository, Whisperr:
- Clones the default branch and works on its own branch,
whisperr/instrumentation. - Installs the Whisperr SDK and wires
identify,resetand your events. - Runs the repository’s own type check, lint and build commands.
- Registers the events it wired.
- Writes a report in the pull request and marks it ready for review.
The dashboard shows the state of each run and its pull request. A pull request stays a draft when the run stops early, changes nothing, or its checks fail or cannot run. The report in the pull request says which.
For Swift apps, Whisperr builds the app before and after the change on a macOS machine and checks that the change adds no new build errors.
Merge and deploy
Section titled “Merge and deploy”Review the pull request on GitHub, merge it and deploy your app. Events arrive only after the new code runs. The Your code rows on the Integrations page show when the first events arrive.
Which stacks does the pull request agent support?
Section titled “Which stacks does the pull request agent support?”Flutter, Next.js, React Native and Expo, browser JavaScript and TypeScript, Node.js, Python, PHP, Swift and C#/.NET. A repository whose runtime is Go, F#, VB.NET or server-side Dart stops before any edits.
What can the Whisperr GitHub App access?
Section titled “What can the Whisperr GitHub App access?”The app reads only the repositories you grant it. For each run, Whisperr uses a token scoped to one repository, with write access to its contents and pull requests, so it can push its branch and open the pull request. Whisperr never gives your ingestion key to the model that writes the code.
To change which repositories the app can read, click Manage on GitHub in the GitHub row. To disconnect, hold Hold to disconnect. The GitHub App stays installed until you remove it on GitHub.
Common questions
Does the Whisperr pull request agent merge anything?
No. It opens a pull request in each repository you pick. You review, merge and deploy it.
Which repositories can the Whisperr GitHub App read?
Only the repositories you grant to the app on GitHub. You can change that access on GitHub at any time. Disconnecting GitHub in Whisperr does not uninstall the app.
Why is the pull request still a draft?
The agent keeps the pull request a draft when the run stops early, changes nothing, or its checks fail or cannot run. The report in the pull request says which.
Who can start the pull request agent?
Workspace owners and admins. Other members see the setup but cannot connect GitHub or start a run.