vertaaux/VertaaUX Audit
Run UX audits with score thresholds and regression detection
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| url | URL to audit | yes | — |
| api-key | VertaaUX API key | yes | — |
| github-token | GitHub token for PR comments | no | ${{ github.token }} |
| mode | Audit mode (basic, standard, deep) | no | basic |
| wait | Wait for audit completion | no | true |
| timeout | Wait timeout in milliseconds | no | 120000 |
| threshold | Overall score threshold (fail if below) | no | — |
| thresholds | Per-category thresholds in YAML format (usability: 70, accessibility: 80) | no | — |
| fail-on-critical | Fail if critical issues found | no | true |
| fail-on-regression | Fail if score regresses from baseline | no | false |
| comment-on-pr | Post comment on pull request | no | true |
| update-baseline | Update baseline file (usually only on main) | no | false |
| baseline-file | Path to baseline file (.vertaaux-baseline.json) | no | — |
| config-file | Path to .vertaaux.yml config file | no | — |
Outputs
| name | description |
|---|---|
| usability-score | Usability score (0-100) |
| clarity-score | Clarity score (0-100) |
| accessibility-score | Accessibility score (0-100) |
| overall-score | Overall score (0-100) |
| issues-count | Total issues found |
| critical-count | Critical issues count |
| report-url | URL to full report on vertaaux.ai |
| job-id | Audit job ID |
| result-json | Full JSON result |
| regression-detected | Whether a score regression was detected |
| baseline-comparison | JSON comparison to baseline |