GitHub Action that scans your Salesforce or ServiceNow pull requests against Quality Clouds' governance, security, and platform-standard rules, with inline results.
Add a workflow file, for example .github/workflows/quality-clouds.yml:
name: Quality Clouds
on:
pull_request:
permissions:
pull-requests: write
jobs:
scan:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Quality Clouds Scan
uses: qualityclouds/action-full-scan@2.0.0
with:
mode: cloud
token: ${{ secrets.QC_TOKEN }}
review: true
allIssues: true
gitHubToken: ${{ secrets.GITHUB_TOKEN }}
pr_fails_on_blockers: trueThe permissions: pull-requests: write block is required for review: true to post inline PR comments; without it, comments silently fail to post.
Requires a Quality Clouds license. Existing customers: generate an API key in the Admin Portal and store it as a repository secret. The secret name is up to you: QC_TOKEN above is just an example, match it to whatever you name the secret in your repository settings. New to Quality Clouds: get in touch to set up a plan for your team.
| Input | Required | What it does |
|---|---|---|
token |
Yes | API key used to connect your Quality Clouds ruleset. |
mode |
No | local (default) scans a given zip file. cloud scans the branch the action runs on. |
cloud |
No | Set to servicenow for a ServiceNow repo. Defaults to Salesforce. |
zip_path |
No | Path to the zip file to scan. Only used in local mode. |
review |
No | Set true to add inline PR comments. Only used in cloud mode. |
allIssues |
No | Set true to show blockers and non-blockers. Only used in cloud mode. |
codequality |
No | Set true to generate a code-quality JSON report. Only used in local mode. |
gitHubToken |
No | Required if review is true. |
pr_fails_on_blockers |
No | Required if review is true. Fails the PR check when the Quality Gate doesn't pass. Quality Gate thresholds are configured in your Quality Clouds workspace, not in this action. |
- Product: qualityclouds.ai
- Documentation: qualityclouds.com/documentation
- Questions and bugs: community
Built by Quality Clouds, governing enterprise platforms since 2017.
