Unified Language User Guides
Test Drive iCR 4.0
Test Drive iCR 4.0
  • Table of contents
    • Introduction
    • Overview
    • Using the Navigator
      • Connecting to the Navigator
      • The Navigator top banner
      • The Analysis Engine status
      • Selecting Your Source Code
        • Using GitHub Projects
        • Selecting your branch
        • Limiting the files to be analyzed
    • Using the Analysis Engine
      • Initiating an analysis
      • Monitoring the analysis
      • Interrupting the analysis
    • Reviewing your results
    • When you are complete
    • Appendix – Language Specific Fixer Lists
    • Appendix – Example Summary Report
    • Appendix - Sample Bug Listing
Powered by GitBook
On this page
  1. Table of contents
  2. Using the Navigator
  3. Selecting Your Source Code

Selecting your branch

PreviousUsing GitHub ProjectsNextLimiting the files to be analyzed

Last updated 1 year ago

In our example, the Baritone project shows many branches. Only one branch at a time can be selected. That is reflected using the radio buttons to choose which branch to examine. Let’s look at the master branch.

Notice that once a branch is selected an icon: appears at the end of the branch name. This icon represents access to the MonoRepo feature within iCR.

, "a monorepo is a software-development strategy in which the code for a number of projects is stored in the same repository." iCR supports this by allowing a User to navigate down through the directory structure of a branch and select the project within the branch to be used for analysis. For demonstrating this, we will use a different example repository called apicurio-registry.

The User can navigate through the directory structure to identfy the specific project or directory of the branch which they wish to analyze. By default, the top directory. In tis example Baritone is selected. Once selected, clicking the Set directory button will reduce the scope of the analysis to that chosen directory. That choice will remain in place until the User chooses a different directory in the future. To remove the scoping selection, simply choose the top directory once again. We'll click on buildSrc as our example.

Once the selection popup is closed, the branch list returns. If a subdirectory was selected, the name of the selected subdirectory is shown above the branch menu items just below the branch's name. Since we chose to limit the analysis to the buildSRrc directory in this example, it is shown below:

NOTE: Only a single subdirectory can be chosen as the project to be analyzed for any repository and selected branch.

With the branch selected along with any possible subdirectory, the branch displays three options:

  • Analyze

  • Review

  • Update

The third button, Update, is made available when the current status of the branch is out of date with the currently checked-in status. That is, it may be “behind” the current master copy of the branch on the VCS repository. This is not unusual in that your developers may be working with a branch while others are also working on it. If you have made updates to the branch using the Reviewer those changes may already have been incorporated into the “main” branch.

Even though you may not have completed reviewing all of the corrections offered in the last analysis, you may decide to interrupt that process and perform a more up-to-date analysis using the latest “main” version. If so, you can select the Update button. This will cause the Navigator to pull-down the most recent version of source code to the iCR server.

Naturally, this will make further review of the old source invalid and so should be followed by a click of the Analyze button, to perform a new analysis of the updated source code. In such a case, you may also decide to simply Remove the project entirely and Clone it again. Doing so removes all past history of earlier analyses.

Clicking on the icon brings up the following selection window:

The first button, Analyze, is always available and allows you to perform an analysis on the branch. Clicking on it will take you to the Analysis screen which will display status on the ongoing analysis. Refer to for a more in-depth discussion of the Analysis Engine operation.

The second button, Review, is not available unless one of more analyses of this branch have been executed. Once an analysis is complete, you would want to click Review so that you can begin the process of looking at the detected problems and the corrections that iCR has provided. covers the details of the Reviewer within iCR.

Analysis Engine
Handling Results
According to Wikipedia