Getting Started with Inspecode

Welcome to Inspecode! With this quick guide, we will introduce you to the essentials of getting started with Inspecode, a service catering to the needs of developers who spend too much time on configuring various source code analysis tools. With support for more than 60 of the best tools available such as Checkstyle, golint, Pyflakes, Inspecode aims to significantly speed up your development process by providing automated code review and code correction for your GitHub/Bitbucket repositories. Our tool-level parallelization process allows us to instantly deliver your results.

This guide will walk you through the essentials of getting started with Inspecode.

Creating a GitHub Repository

For our guide, you are going to fork an existing GitHub repository and register it with Inspecode. However, if you already have a repository you can skip to the next chapter. Just remember that you need Admin access to the repository you wish to register with Inspecode.

The repository that you are going to fork is gorilla/websocket, a Go implementation of the WebSocket protocol.

Go to the project’s GitHub page and simply click the fork button in the top right corner:

github fork

Once you have successfully forked the repository, you are ready to sign up with Inspecode.

Sign Up to Inspecode

To sign up, go to the Inspecode homepage and click the signup button in the top right corner:

inspecode signin

Then, it is just as easy as choosing between your GitHub or BitBucket accounts:

choose account

GitHub will ask you to allow Inspecode access to your repositories. To do so, just click Authorize rocro button. If you use organization accounts in GitHub, please refer to the page "How to Grant Access to a GitHub Organization".

authorize rocro

Congratulations, with just a few mouse clicks you registered with Inspecode!

Now let’s move forward and see how to register your repository.

Repository Registration

With Authorize rocro button clicked, you will land on the main page that lets you register your repositories and access the reports. For now, you don’t have any repositories registered so you need to add one. To do so, just select the Repositories from the top menu:

repository config

Most probably, Inspecode already synced the list of your repositories and all you have to do is to click the Register button. However, if you can’t see your repositories as in the below image, just click the Sync button in the top right corner and wait for Inspecode to refresh the page.

repository sync

Your First Report

Now that you registered a repository, you can move to the reports page by selecting Reports from the top menu:

move to report

As you can see, there is already a report available to you. If it is not shown, you need to perform a synchronization using the button in the top right corner.

report sync

Now click the report button and Inspecode will display an easy to understand summary of your repository:

report summary

Besides the summary, Inspecode provides three additional tabs (Files, Issues, and Trends) that are designed to let you gain access to more in-depth information.

By choosing the Files tab, Inspecode will show you detailed information about the issues found in each of your files such as number, complexity, and location:

report details

The issues tab will show you all the problems found in your code and will allow you to filter them based on several criteria such as:

  • severity level (All, Ignore, Info, Warning, Error, and Critical),
  • status (All, New, Fixed), and
  • the tool that identified the issue (e.g.: Complexity, golint, misspell)

report issues

Watching and Unwatching Branches

Once you have registered a new repository, Inspecode is going to automatically watch all its branches. This means that whenever a new commit or a pull request happens, Inspecode will automatically start a new job to analyze the code. However, it is possible to configure Inspecode to unwatch a particular branch. To find out more information about watching/ unwatching a branch you can visit our dedicated help page here.

As we already mentioned, Inspecode will also launch a new job each time a pull request notification is received from GitHub. Read the full Branches article here to find out how jobs are created in case of a pull request.

Programming Language Detection

Now that you have set up your repository and generated the first report with just a few mouse clicks, you might have already guessed that Inspecode is capable to automatically detect the programming language for each repository and use the appropriate tools. For now, the following languages are supported:

However, if the default settings do not suit your needs, Inspecode provides many configuration options. Read more about how to customize the code analysis here.

Great job! You have successfully gone through registering a repository with Inspecode and creating your first report.

results matching ""

    No results matching ""