GitHub Integration Overview

The Quality Clouds GitHub Integration brings automated code quality analysis directly into your development workflow, allowing Salesforce teams to identify issues, enforce quality standards, and review scan results without leaving GitHub.

By combining Feature Branch scans, inline feedback, and optional Quality Gates, developers receive immediate guidance on every Pull Request, helping teams improve code quality while reducing review time and technical debt.

 

Overview #

The GitHub Integration connects your GitHub repository with Quality Clouds to automatically analyze Salesforce metadata whenever code is pushed or a Pull Request is created.

Instead of waiting until later stages of the development lifecycle, developers receive immediate feedback while changes are still being reviewed. Scan results are displayed directly inside the Pull Request, allowing issues to be resolved before code is merged.

The integration supports:

  • Automatic Feature Branch scans
  • Inline Pull Request feedback
  • Optional Quality Gates
  • Best practice validation
  • Security, performance, maintainability, and governance checks
  • Direct links to remediation guidance

This enables development teams to adopt a shift-left approach, identifying quality issues earlier in the Software Development Lifecycle (SDLC) and reducing the effort required during testing and release preparation.

 

Key Capabilities #

Automatic Feature Branch Scans #

Every Pull Request automatically triggers a Feature Branch scan in Quality Clouds. The scan analyzes only the proposed changes, allowing developers to focus on new issues introduced during development.

No manual actions are required after the integration has been configured.

Inline Pull Request Feedback #

Quality Clouds publishes scan results directly within the Pull Request.

Receive immediate feedback during code review:

  • Files containing issues
  • Line numbers
  • Severity
  • Impacted best practices
  • Rule descriptions
  • Links to remediation documentation

This eliminates the need to switch between GitHub and external tools during code review.

Quality Gates #

Quality Gates can optionally be enabled to enforce your organization’s coding standards.

When enabled, every Pull Request is evaluated against the configured Quality Gate before it can be merged.

Organizations can use Quality Gates to ensure that critical quality requirements are consistently applied across all repositories.

Best Practice Guidance #

Every issue detected by Quality Clouds includes a description explaining why it was raised together with a link to the corresponding documentation.

This helps understand the recommendation, learn platform best practices, and resolve issues more efficiently.

Continuous Quality Monitoring #

Every time new commits are pushed to the Pull Request, Quality Clouds automatically launches a new scan and updates the results.

Developers always review the latest quality status without needing to rerun scans manually.

Development Workflow #

The GitHub Integration is designed to fit naturally into your existing development process.

Step 1 – Push Changes

Commit and push changes to a feature branch as usual.

Step 2 – Create a Pull Request

Opening a Pull Request automatically triggers a Quality Clouds Feature Branch scan.

No additional actions are required.

Step 3 – Code Analysis

Quality Clouds analyzes the proposed changes against:

  • Salesforce best practices
  • Security recommendations
  • Performance guidelines
  • Maintainability rules
  • Custom Quality Clouds recommendations
  • Your organization’s configured Quality Gates (if enabled)

Step 4 – Review Scan Results

Once the scan has completed, GitHub displays the results directly inside the Pull Request.

Developers can review:

  • Issues detected
  • File locations
  • Severity
  • Rule descriptions
  • Documentation links

This allows issues to be understood and resolved without leaving GitHub.

Step 5 – Resolve Issues

Update the code to resolve the reported findings.

After pushing additional commits, a new Feature Branch scan automatically runs and refreshes the Pull Request results.

Step 6 – Code Review

Reviewers evaluate both the code changes and the Quality Clouds scan results before approving the Pull Request.

If Quality Gates are enabled, reviewers can quickly determine whether the Pull Request satisfies the organization’s quality requirements.

 

Quality Gates #

Quality Gates allow organizations to define minimum quality requirements before code can be merged.

Rather than relying solely on manual review, Quality Gates automatically evaluate Pull Requests against predefined quality criteria.

Depending on your configuration, Pull Requests can:

  • Pass all quality checks
  • Fail because Quality Gate conditions were not met

When configured to enforce Quality Gates, GitHub can prevent Pull Requests from being merged until blocking issues have been resolved.

Quality Gates help teams:

  • Maintain consistent coding standards
  • Reduce production defects
  • Prevent critical issues from reaching higher environments
  • Improve governance across development teams

Quality Gates are optional and can be configured according to your organization’s development policies.

Write-Off Requests #

Not every issue requires remediation.

In some situations, findings may represent an accepted technical decision or a justified exception.

For Salesforce repositories, developers can request a Write-Off directly from Quality Center for Salesforce.

From the Feature Branch Scans view, developers can:

  • Review detected issues
  • Select one or multiple findings
  • Provide a business or technical justification
  • Submit the request for approval

This allows exceptions to follow a governed approval process without interrupting the development workflow.

For more information, refer to the Quality Center for Salesforce documentation.

Benefits #

For Developers #
  • Receive immediate feedback during code review
  • Detect issues before code is merged
  • Understand findings through detailed explanations
  • Access remediation guidance directly from GitHub
  • Reduce review cycles and rework
  • Improve familiarity with Salesforce best practices
  • Stay within the GitHub workflow without switching tools
For Reviewers #
  • Review quality results alongside source code
  • Quickly identify critical findings
  • Make more informed approval decisions
  • Reduce manual verification effort
  • Improve consistency across code reviews
For Organizations #
  • Improve overall code quality
  • Reduce technical debt
  • Standardize development practices
  • Enforce governance through Quality Gates
  • Detect issues earlier in the SDLC
  • Reduce release risk
  • Deliver higher-quality Salesforce applications faster

Next Steps #

After understanding how the GitHub Integration works, the next step is to configure the GitHub Action used to trigger Quality Clouds scans.

Continue with:

Was it helpful ?