Skip to main content

Branch health scans in Gearset

How to use Gearset Code Reviews to diagnose technical debt in your repositories.

Written by Alec Short
Updated yesterday

Get a deeper understanding of your technical debt with Code Reviews branch scans in Gearset. These scans automate more than 100 checks - many based on Salesforce's Well Architected framework & OWASP top 10 vulnerabilities - so you can better understand the security and quality of your applications.
​

How to get started

  1. Choose your VCS type and repository.

    1. Note: this feature is currently supported natively for Github cloud, Github Enterprise cloud, Bitbucket cloud, and Gitlab cloud. For other providers, you'll be routed out to the Code Reviews app until they're supported natively.

  2. Wait for your scan to complete.

  3. Review your results πŸŽ‰

    1. You can click into the Code Reviews App to dive in deeper.


Understanding my scan results

Issues

In your scan, you'll find a detailed breakdown of flagged problems, each assigned a severity level to indicate its risk and impact on technical debt within the application.

The severity levels are as follows:

  • Critical: These issues pose significant risks, such as exposing sensitive data or allowing attackers to execute code on your application. They have a high impact on technical debt and require immediate resolution. Critical issues act as blockers for pull requests.

  • Error: These issues can place the application at risk and contribute to technical debt. They should be prioritized for fixing as soon as possible and also act as blockers for pull requests.

  • Warning: These issues have a minor impact on the application, with low rework requirements. They do not block pull requests but should still be addressed for optimal code quality.

This classification system helps you focus on the most critical problems while maintaining a clear path for improving overall application health. See more information on Scan results in Code Reviews here: Understanding Code Reviews Scan results


​

You can also see a 'tag' column on your scan results. This refers to the Well Architected policy that is associated with this violation, e.g. Secure or Compliant. By filtering on 'tag', you can see only issues in specified categories.



Fix effort

Fix effort refers to the estimated time and resources required to address and resolve identified issues in a codebase. The effort is measured in terms of hours or days and is influenced by the severity and complexity of the issues. Understanding remediation effort helps teams prioritize tasks, allocate resources effectively, and maintain a healthier, more maintainable codebase.

Did this answer your question?