Softagram "Impact Report" is automatically generated change analysis for every Pull Request (In Bitbucket/AzureDevOps/GitHub), also called Merge Request (GitLab), or Patch set(Gerrit). Automation that helps the author and reviewers to ensure the quality of the change faster with the visual aid and automated dependency checks. 

The report appears in the "discussion" field, see example in GitHub:

How to read Softagram "Impact Report"? Please see below the information of the report explained.

Header

 Header tells the Pull/Merge request number (in example 2) and the latest commit id (a3c10a3) where the analysis is based on. Note that Softagram provides only one report and updates it with the latest commit

Change Overview

Change overview tells the change in one glance. In this graph you can see where the change is done (Test/assertion and Assert.java files in example). The impact of the change is seen also clearly. 

In the graph you can see:

  • Changed elements and dependencies (Green= New, Yellow= Modified, Red=Removed)
  • All elements that are possibly impacted of the change (Blue)

Note that if the change is large, the graph is automatically abstracted to provide meaningful amount of information. That's why some elements are shown in higher level (e.g. function changes in class or file level, or file changes in folder (component) level). 

Details of Dependency Changes

Detailed dependency changes illustrates all removed/added or modified dependencies in this particula Pull/Merge request. It tells also all new or changed elements (the ones with new dependencies) as well as shows e.g. all added dependencies to external libraries.

Insights

Insights are optional value added information that are present when actionable issues are found. Currently Softagram analyses Co-Change Alerts and Dependency Rule violations.

Co-change Alerts are analysed automatically with the machine learning algorithm based on the change history of the projects. System automatically detects what files are most likely to be changed at the same time and alerts if this given pull request is changing just one of the files.

Dependency Rule Violations will alert if you are trying to introduce a new unwanted dependency in this pull request. Rules are pre-defined, not automatically detected. Exiting rule violations are seen in the graph with exclamation marks, but only the added or removed (in that particular pull request) are described in text.

Read this help document to learn how to configure Dependency Rules.

Full Report and more details?

You can open the pull request report also in softagram server web frontend. That view will be having more details in the change. You can also open the pull request in the Softagram Desktop to browse the change in detailed level. Please read this article of how to do that!

Did you have something that was not explained?
Don't hesitate to ask that via Chat!! 👉

Did this answer your question?