This page is about the Code Review feature available for GitHub Pull Requests.

Disclaimer

This feature requires to have the GitHub App installed and works only for users with the GitHub App.

Feature

The feature works as is:

  1. Developers send a Pull Request on GitHub
  2. Pull Requests is being inspected by Code Inspector.
  3. The Code Review is being added as a check
  4. Any subsequent commits from developers on the code review are being inspected as well.

Note that any commit on the pull request will trigger a new analysis. Each Analysis is between the base commit of the pull request and the latest commit at the time of analysis.

Example

The request of the Code Review is shown on the Pull Request (as shown below). You notice three sections:

  1. Code Inspector - Pull Request Code Review: this is the code review part, that interests you!
  2. code-inspector/violations: this gives a simple signal if this pull request introduce more violations (useful to automate merge based on the number of introduced violations)
  3. code-inspector/duplicates: this gives a simple signal if this pull request introduce more duplicates (useful to automate merge based on the number of introduced duplicates)

The Code Review is what is available in the first item. The two other elements are useful if you want to interface Code Inspector with Mergify (you can read our blog post about it).

Pull Request

You can also see the errors surfaced for each file. For each error reported, our engine surfaces:

  1. severity: is that an important issue?
  2. category: what type of issues is it? (e.g. documentation, security, safety, etc.)
  3. description: a short description of what the problem is.

Pull Request Files

Ignore violations

Sometimes, some errors surfaced by code analysis are not relevant (such as code-style). You can ignore some rules reported by our engines. Ignored rule will be ignored for the next analysis but also for any analysis on our platform.

Resolve link on a GitHub Pull Request

To ignore a violation, go on the resolve link on the Pull Request (as shown above). That will connect you on a page on code-inspector (make sure you are logged on the website). Just click on the Ignore button on that interface to ignore a violation. Next analyses and code reviews will not include this rule.

Ignore a violation in a Pull Request

Need help?

If you have any question regarding the migration (or any other topic), please contact us.