Skip to content

kuality-io/action

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

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

Kuality GitHub Action

Test any website for accessibility, performance, SEO, cross-browser compatibility, and 30+ QA dimensions — directly in your CI/CD pipeline.

Usage

- uses: kuality-io/action@v1
  with:
    api-key: ${{ secrets.KUALITY_API_KEY }}
    url: https://staging.example.com
    types: a11y,webvitals,seo
    fail-on: high

Inputs

Input Required Default Description
api-key Yes Kuality API key (ku_... token)
url Yes URL to test
types No web Comma-separated test types
fail-on No high Fail on severity: high, medium, low, none
score-threshold No 0 Minimum score (0-100)
max-high No Max high-severity findings allowed
max-medium No Max medium-severity findings allowed

Outputs

Output Description
status pass or fail
score Overall quality score (0-100)
high Total high-severity findings
medium Total medium-severity findings
low Total low-severity findings
report-url Link to full report on kuality.io

Available Test Types

a11y, webvitals, seo, broken_links, headers, cookie, tech, cms, api, js_audit, ssl, email, web, firefox, webkit, uxaudit, animation, colorblind, assets, screenreader, performancebudget, assetaudit, bundlesize, ttfb, throttle, memoryleak, touchaudit, touchsize, orientation, pwa, mobilelighthouse, contract, graphql, openapi, privacyscan, csp, cors, synthetic, cdnaudit, formaudit

Examples

Accessibility gate

name: QA
on: [pull_request]
jobs:
  quality:
    runs-on: ubuntu-latest
    steps:
      - uses: kuality-io/action@v1
        with:
          api-key: ${{ secrets.KUALITY_API_KEY }}
          url: https://staging.example.com
          types: a11y
          fail-on: high

Full QA suite with score threshold

- uses: kuality-io/action@v1
  with:
    api-key: ${{ secrets.KUALITY_API_KEY }}
    url: https://staging.example.com
    types: a11y,webvitals,seo,broken_links,headers
    fail-on: medium
    score-threshold: 80

Use outputs in later steps

- uses: kuality-io/action@v1
  id: qa
  with:
    api-key: ${{ secrets.KUALITY_API_KEY }}
    url: https://staging.example.com
    types: a11y,webvitals
    fail-on: none

- run: echo "Score is ${{ steps.qa.outputs.score }}"

- uses: actions/github-script@v7
  if: github.event_name == 'pull_request'
  with:
    script: |
      github.rest.issues.createComment({
        owner: context.repo.owner,
        repo: context.repo.repo,
        issue_number: context.issue.number,
        body: `**Kuality QA:** ${{ steps.qa.outputs.status }} | Score: ${{ steps.qa.outputs.score }} | [Full report](${{ steps.qa.outputs.report-url }})`
      })

Get your API key

  1. Sign up at kuality.io
  2. Go to Organization Settings > API Keys
  3. Create a key and add it as a repository secret named KUALITY_API_KEY

Links

About

GitHub Action — Test any website for accessibility, performance, SEO & 30+ QA dimensions with Kuality

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages