Getting Started

Welcome to CodeScene - we’re happy to have you here! This guide will help you get started. Before we go there, let’s have a look at what CodeScene does for you.

The history of your code predicts its future

CodeScene is a tool that your software project improve their efficiency by identifying and prioritizing technical debt. We take a different approach to software analysis since we base the results on behavioral and social data.

Our main data source is version-control repositories, which CodeScene views as a behavioral log of how the developers interact with the codebase. This means we can prioritize based on how the system grows and also include a social dimension of code that lets our customers discover team productivity bottlenecks and save on- and off-boarding costs.

The only pre-requisites are that:

  • You have your source code in one or more Git repositories.

  • Your Git repositories are hosted on GitHub.

If you don’t have a GitHub account we recommend that you check-out our on-premises version of CodeScene.

Login with GitHub

When you click on the Login button on CodeScene’s front page you’ll be redirected to GitHub for authentication and authorization. Type your GitHub credentials as shown in Fig. 1.

Sign into GitHub

Fig. 1 Sign in using your GitHub credentials.

Because of how the GitHub API works, CodeScene is forced to request read and write access. We do, however, never write any data to your Git repositories, and we never will.

With that covered you’re ready to analyze your project.

Run your first analysis

Click Create New Project to configure an analysis project. CodeScene fetches a list of all your repositories from GitHub and lets you specify the projects to analyse as shown in Fig. 2.

Create an analysis project

Fig. 2 Specify the repositories to analyse.

CodeScene’s free plan lets you analyse open source projects. The paid plans also let you analyse private repositories as well as repositories that belong to an organization you’re a member of.

CodeScene also supports projects where the code is split across multiple repositories. In that case you just selects all those repositories and CodeScene will take care of the rest.

Once you’ve selected the repository to analyse, CodeScene prompts you with the initial configuration as shown in Fig. 3.

Configure your analysis project

Fig. 3 Specify the content to exclude from your analysis.

This dialog lets you specify a set of Exclusion Filters. Those filters are used to exclude content from the analysis. You typically use it to get rid of auto-generated content, checked-in build artifacts, or third-party code. By specifying a filter your analysis results will become more focused and easier to interpret. Note that you can change the filter at anytime through the project’s analysis configuration.

That’s it! No further setup is necessary. Just press the button in CodeScene to launch your first analysis. The analysis may take some time to complete so we recommend that you use that time to check-out our Guides. They’ll make sure you get the most out of your analysis.

Run a retrospective analysis

CodeScene also includes the option to run an analysis tailored to a Retrospective, and lets a team evaluate how their work in the current sprint/iteration impacted the codebase. You launch a retroseptive using the rewind button highlighted in Fig. 4.

Start a retrospective analysis

Fig. 4 Start a retrospective analysis of your team’s effort in a sprint.

To learn more about the retrospective feature and its use cases, we recommend that you check out the article on Relevant Retrospectives.

Set an automatic analysis schedule

If you’re on CodeScene’s paid plan you can enable automatic analysis runs on your project.

Open the project configuration page and go to Analysis Schedule tab shown in Fig. 5.

Add schedule for automatic analysis

Fig. 5 Specify the content to exclude from your analysis.

You can choose an interval and click Save. An analysis will be run once every interval. The specific time within that interval will be shown to you.

It is recommended that you enable scheduled analyses for projects in active development.

A scheduled analysis will be skipped if you’ve recently manually triggered an analysis run.