Code Inspector Documentation

Code Inspector Documentation

  • Getting Started
  • Integration
  • API
  • FAQ

›Integrations

Integrations

  • Introduction to Integrations
  • GitHub Integration
  • Gitlab Integration
  • Bitbucket Integration
  • Slack Integration
  • Continuous Integration
  • GitHub Action

GitHub Integration

GitHub Accounts

When you log into Code Inspector with GitHub, you have to use our GitHub App. Adding or removing a repository is done through the GitHub App.

GitHub App

The video below shows how to install the Code Inspector GitHub App.

All the details of the App is available below.

Projects Management

Adding or removing projects to your account is done through the GitHub App. To manage the GitHub App, select the Manage GitHub App menu entry (as shown below).

Manage GitHub App menu entry

Group Management

GitHub users cannot create groups. Instead, GitHub organization are mapped into groups. When logging on Code Inspector, the platform detects if any organization you belong to is on Code Inspector and automatically adds you to it if you belong to it.

Automated Code Review

GitHub accounts are automatically enrolled in automated code review: when a pull request is created, the engine compares the new code with the previous one and annotate the pull requests with the various violations, code duplicates and complex/long functions.

That way, code issues are automatically detected before pushing change. Automating code reviews also save significant developers time since it catches small errors before human reviewers do it.

Note: automated code reviews work only on GitHub App. You need to log in with GitHub and install the GitHub App on your repository to have automated code reviews.

Permissions and Security

Our engine can access only repositories you gave access to when you selected the list of repositories you want to get access to. For that reason, pull requests from other repositories cannot be processed since the GitHub app has not granted access to these repositories.

We is a design decision: we wanted to design Code Inspector with user privacy in mind.

Supported features

  • Login
  • Select Repository through list
  • Automated Code Review (pull request being commented)
  • Upgrading account limites through payment on the marketplace.
← Introduction to IntegrationsGitlab Integration →
  • GitHub Accounts
  • GitHub App
    • Projects Management
    • Group Management
    • Automated Code Review
    • Permissions and Security
  • Supported features
Code Inspector Documentation
Docs
Getting StartedIntegrationsAPI Reference
Community
SlackTwitter
More
Medium
Follow @code_inspector
Copyright © 2021 XCoding labs, LLC