DocsCode Review

PR Commands

Talk to Solemly from a pull request comment: review, ask, explain, ignore and more.

Start a pull request comment with @solemly, followed by a command.

Commands#

CommandWhat it does
@solemly reviewReview the latest commit now.
@solemly review fullReview again, even if this commit was already reviewed. Also review again.
@solemly review alwaysReview every new commit on this pull request, whatever the repository's setting.
@solemly pauseStop automatic reviews on this pull request. @solemly review still works. Also stop.
@solemly resumeGo back to the repository's setting.
@solemly ask <question>Answer a question about this change, using the diff, the latest review and the repository.
@solemly explainReply to a finding to get the reasoning and evidence behind it.
@solemly ignoreReply to a finding to dismiss it for the rest of this pull request. Also dismiss.
@solemly describeWrite a summary into the pull request description. Also summary.
@solemly helpShow this list.
 
@solemly ask does this change the retry behaviour for failed webhooks?

How commands are read#

  • The command must be on the first line of the comment, starting with @solemly. Case doesn't matter.
  • A free-form sentence after @solemly is treated as a question, so @solemly why is this cached? works like ask.
  • Solemly reacts with 👀 when it picks up a command, then replies in the thread.

Replying to a finding#

explain and ignore work on a single finding, so post them as a reply in that finding's thread. On GitHub, that's the inline comment. A dismissed finding isn't raised again on that pull request.

Who can run commands#

Only people with write access to the repository can run commands: write or admin on GitHub and Bitbucket, Developer or higher on GitLab. Comments from anyone else are ignored without a reply.

Not available yet#

fix, tests and ignore <path> are recognised, but Solemly replies that they aren't available yet. To fix findings with an agent today, see Fix with Your Agent.

Something missing or unclear? Tell us.