Skip to content

qualityclouds/action-full-scan

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

BANNER

  1. Built for Salesforce. Designed for GitHub.
  2. What Is Quality Clouds?
  3. Why Your Linter Isn’t Enough
  4. For Builders and Gatekeepers
  5. Set It Up Once. Scan Every Pull Request.
  6. Use with Your Existing Quality Clouds License
  7. Configuration Inputs and Options
  8. What You’ll See That Others Don’t
  9. Get Started in Under a Minute
  10. Need Help or Want to Learn More?

Built for Salesforce. Designed for GitHub.

Quality Clouds Build Check for Salesforce brings platform-specific governance directly into your GitHub workflow.

Whether you're managing metadata, enforcing org-wide naming standards, or safeguarding production from non-compliant changes, this GitHub Action delivers instant, actionable insights when a pull request is opened.

It’s the ultimate native pull request tool designed specifically for Salesforce teams, trusted by enterprise architects, release managers, and developers who care about getting it right before anything ships.

Because when code lives in GitHub but breaks in production, generic linters aren't enough.

What Is Quality Clouds?

Quality Clouds is the AI-powered governance layer built for enterprise platforms, starting with Salesforce.

We go beyond generic code checks by scanning platform-specific configurations, metadata, and code against your org’s quality and compliance KPIs.

Trusted by Fortune 500 teams, Quality Clouds helps developers, architects, and release managers catch issues early, enforce standards automatically, and ship with confidence- now directly from GitHub.

PARTNERS_CLIENTS LOGOS

Why Your Linter Isn’t Enough

Most linters catch syntax and formatting issues. But:

  • They don’t understand Salesforce.
  • They miss metadata risks, naming violations, and org-specific rules that can break releases..

Quality Clouds checks code, configuration, and compliance in one scan. Everything is aligned to your platform’s standards.

Because clean code isn’t enough. It has to be correct for your environment.

LINTERS VS QC

For Builders and Gatekeepers

For Developers

Get instant feedback inside GitHub. See what needs fixing, why it matters, and how to resolve it before code review. Reduce back-and-forth, avoid late rework, and improve with every pull request.

For Release Managers & Architects

Enforce platform standards automatically while keeping teams moving. Gain visibility into every pull request, apply organization-specific rules, and ensure only compliant code moves forward.

This is how quality becomes part of the process, not a blocker at the end.

Set It Up Once. Scan Every Pull Request.

  1. Install the Quality Clouds Build Check plugin from the GitHub Marketplace
  2. Add your API key to your YAML file
  3. Open a pull request and the scan runs automatically
  4. Review and approve directly in GitHub with clear, inline results

No tool switching. No extra setup. Just instant feedback where your team already works.

Use with Your Existing Quality Clouds License

If you already have a Quality Clouds license, you’re ready to go. Just connect your account using your API key and start scanning pull requests right inside GitHub.

New to Quality Clouds? Reach out to us and we’ll help you get started with the right plan for your team.

This GitHub Action is built to extend the value of your existing platform governance -seamlessly, without switching tools.


Configuration Inputs and Options

Input Required Description
token ✅ Yes You need to provide a valid API key to connect the Quality Clouds ruleset against which your code will be checked. To obtain an API key, contact your Quality Clouds admin. If you're an admin, check the Administering API keys article.
mode Optional local (default) or cloud. Local mode performs a live check of the files. Cloud mode runs a scan against the branch of the repository where the action is performed.
review Optional true adds inline PR comments. Only used in cloud mode.
allIssues Optional true shows blockers + non-blockers. Only used in cloud mode.
gitHubToken Optional Only used ifreview is true.
pr_fails_on_blockers Optional Only used ifreview is true. Determine if the PR should be marked as failed when the Quality Gate does not pass.

Example Usage

name: QualityClouds

# Controls when the action will run. 
on:
  # Triggers the workflow on push or pull request events
  push:
  pull_request:
  
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  build:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      - uses: actions/checkout@v2

      - name: Quality Clouds Scan
        uses: qualityclouds/action-full-scan@2.0.0
        with:
          mode: cloud
          token: 'MyGitQCToken'
          review: True 
          allIssues: True 
          gitHubToken: 'MyGitHubToken'
          pr_fails_on_blockers: True

What You’ll See That Others Don’t

Quality Clouds Build Check gives you visibility that generic linters miss, because it understands Salesforce, not just syntax.

  • Automated Branch Scans – Automatically trigger code and configuration scans on every pull request. .
  • Integrated Quality Gates – Enforce your org’s specific compliance and quality rules before merge.
  • Inline Issue Reporting – See exactly what’s wrong, where it is, how severe it is, and how to fix it, right inside GitHub.
  • Context-Aware Feedback – Developers get real-time insights where they code, improving quality and learning on the go.
  • Simple API-Key Setup – Connect securely in minutes, no complex setup or switching tools.
  • This is quality governance, not just linting. And it’s built for how Salesforce teams actually work.

Get Started in Under a Minute

  1. Install from the GitHub Marketplace

  2. Paste your API key in the YAML

  3. Open a PR and start scanning instantly

That’s it. No tool switching, no complex configuration. Just instant visibility and quality control built into every GitHub workflow

Need Help?

We’re here to support you every step of the way. Visit our our documentation for setup, API key management, and advanced configuration options.

Still need support?

We’ve got you covered—whether you’re evaluating or already scanning.