Skip to content

v1.0.0 — Designesy Contract Check

Choose a tag to compare

@LE-VAI LE-VAI released this 31 Jul 07:01
· 231 commits to main since this release

v1.0.0 — Designesy Contract Check

First stable release of the Designesy GitHub Action — a design-contract quality gate for CI.

What it does

Scores any URL against the Designesy v0.4.0 design-system contract — 40 deterministic checks across 14 weighted categories (tokens, motion, accessibility, cadence, takt, poise, identity, interaction, performance, responsive, semantic, security, spec, copywriting) — and fails your workflow when the score or grade drops below your threshold.

No LLM. No heuristics. Every check is reproducible and grounded in the published contract.

Features

  • 40-check engine — deterministic, cached ~24h per URL
  • 4 emission formatsdesignesy (native), canonical (review-findings.json schema), review (jakubkrehel markdown), google (design.md-compatible)
  • PR comments — posts a summary comment on pull requests with score, grade, and gate verdict (zero-dependency bare fetch to GitHub REST API)
  • Quality gatingmin-score and min-grade inputs; step fails on regression
  • Job Summary — markdown summary on every run
  • Zero dependencies — Node built-ins only, runs on node24

Usage

- uses: LE-VAI/designesy-org@v1
  with:
    url: https://your-app.vercel.app
    min-score: 70
    min-grade: B
    post-comment: true

Inputs

input required default description
url yes URL to score
min-score no 0 Minimum score (0–100). 0 disables.
min-grade no "" Minimum grade (AF). Empty disables.
format no designesy Emission format: designesy, canonical, review, google
api no https://www.designesy.org Scoring engine base URL
fail-on-error no true Fail on engine errors. Set false to warn.
post-comment no true Post PR summary comment (pull_request events only)
github-token no ${{ github.token }} Token for PR comments

Contract

Designesy v0.4.0 — see designesy.org/contracts/design-system for the full contract and designesy.org/methodology for the scoring methodology.


v1.0.0 patch: Marketplace badge updated from check-circle to radio (dot-in-ring) to match the Designesy favicon and Score Gate hero identity. No functional changes.