CI/CD Integration
Integrate automated WCAG accessibility scans directly into your CI/CD pipeline. ScanClusive supports GitHub Actions, GitLab CI, and Bitbucket Pipelines.
Prerequisites
Create an API Key
Go to Settings → API Keys and create a new API key.
Copy your Project ID
Find your project ID in the project settings or in the URL of your project.
Store the secrets in your CI/CD platform
Save both values as secret environment variables in your CI/CD platform:
SCANCLUSIVE_API_KEY— your API keySCANCLUSIVE_PROJECT_ID— your project ID
Platform Configuration
GitHub Actions
name: Accessibility Scan
on: [push, pull_request]
jobs:
accessibility:
runs-on: ubuntu-latest
steps:
- uses: scanclusive/scanclusive-action@v1
id: scan
with:
api-key: ${{ secrets.SCANCLUSIVE_API_KEY }}
project-id: ${{ secrets.SCANCLUSIVE_PROJECT_ID }}
threshold: 90
fail-on-violations: true
# Save results as artifact for trend tracking
- uses: actions/upload-artifact@v4
if: always()
with:
name: scanclusive-results
path: scanclusive-results.jsonRepository: scanclusive/scanclusive-action
GitLab CI
# Required CI/CD variables (Settings > CI/CD > Variables):
# SCANCLUSIVE_API_KEY - your API key (masked)
# SCANCLUSIVE_PROJECT_ID - your project ID
include:
- remote: 'https://gitlab.com/scanclusive/ci-templates/-/raw/main/.scanclusive-scan.yml'
accessibility_scan:
extends: .scanclusive-scan
variables:
SCANCLUSIVE_THRESHOLD: "90"
SCANCLUSIVE_FAIL_ON_VIOLATIONS: "true"Repository: scanclusive/ci-templates
Bitbucket Pipelines
pipelines:
default:
- step:
name: Accessibility Scan
script:
- pipe: docker://scanclusive/scanclusive-pipe:1.0.1
variables:
SCANCLUSIVE_API_KEY: $SCANCLUSIVE_API_KEY
SCANCLUSIVE_PROJECT_ID: $SCANCLUSIVE_PROJECT_ID
SCANCLUSIVE_THRESHOLD: "90"
SCANCLUSIVE_FAIL_ON_VIOLATIONS: "true"
artifacts:
- scanclusive-results.jsonRepository: scanclusive-prod/scanclusive-pipe
Example Repositories
Full working examples with best practices for each platform:
Configuration Reference
| Parameter | Required | Default | Description |
|---|---|---|---|
| api-key | Yes | — | ScanClusive API key |
| project-id | Yes | — | Project ID |
| threshold | No | 0 | Minimum compliance score (0–100). Pipeline fails if below this value. |
| fail-on-violations | No | false | Fail the pipeline if any critical violations are found |
| wait-timeout | No | 600 | Maximum wait time in seconds |
Compliance Badge
Add an accessibility badge to your README to display the current compliance score:
The badge reflects the score from the latest completed scan and updates automatically.
Ready for automated accessibility testing?
Create a free account and integrate ScanClusive into your pipeline today.
Get started for free