Skip to content

Generate a PR

Last updated

View as Markdown

Generate a PR turns a recommendation into a pull request. DBGorilla writes the change to a branch in the GitHub repository linked to the database and opens a pull request. DBGorilla does not merge the pull request.

The button is on a recommendation’s page, next to Complete and Ignore.

Turn it on

Section titled “Turn it on”

Link a GitHub repository to the database first. GitHub pull request reviews covers installing the DBGorilla GitHub App, connecting it to your workspace and linking the repository.

The button remains disabled until a repository is linked. Hovering over it shows “Connect a GitHub repository to this component first.”

Owner, Admin, Analyst and Developer can all use it.

Generate a pull request

Section titled “Generate a pull request”
  1. Open the component and choose Advisor.
  2. Open a recommendation.
  3. Choose Generate a PR.

The button disappears once DBGorilla starts generating the pull request. If generation fails, the button comes back so you can try again.

The branch is named dbgorilla/recommendation- followed by the recommendation’s number. The DBGorilla GitHub App opens the pull request. GitHub shows the App as dbgorilla[bot], and the same account authors the commit. The pull request is titled with the commit’s subject line. Its description links back to the recommendation, so you can review the evidence and reasoning.

Review and merge it

Section titled “Review and merge it”

Review the pull request as you would any other change. Read the diff, let your checks run, and merge it when you are satisfied. DBGorilla reviews it like any other pull request, so its summary comment and the DBGorilla Review status appear on it.

Section titled “Related”