Skip to content

Chore: Machine readable design system#30484

Open
TeddyCr wants to merge 5 commits into
open-metadata:mainfrom
TeddyCr:MINOR-Machine-Readable-Design-System
Open

Chore: Machine readable design system#30484
TeddyCr wants to merge 5 commits into
open-metadata:mainfrom
TeddyCr:MINOR-Machine-Readable-Design-System

Conversation

@TeddyCr

@TeddyCr TeddyCr commented Jul 24, 2026

Copy link
Copy Markdown
Collaborator

Describe your changes:

Summary

Turns the existing design system into an enforced, LLM-readable token layer and migrates the entire UI CSS/LESS surface onto it. Migration is value-preserving (exact color matches, rem→px exact at the 16px root) — no intended
visual change.

What's in it

  • src/styles/tokens.css — 3-layer tokens: Layer 1 --ds-* primitives → upstream globals.css with raw fallbacks; Layer 2 --om-* aliases (colors, spacing, type, radius, elevation, z-index, motion); components reference only Layer 2.
    Loaded globally via styles/index.ts.
  • Migration — 369 .less/.css files, ~4.7k raw values → var(--om-*) (4,480 usages). Property-scoped and safe: url()/data-URIs, comments, LESS @vars/color-functions/arithmetic, and vendored files are never touched.
  • specs/ — 22 markdown specs: 6 foundations, a generated token-reference.md (797 tokens), and 14 component specs.
  • Tooling (scripts/) — token-audit (CI lint, exit 1 on hardcoded colors/spacing), token-migrate (idempotent codemod), token-gen (regenerate tokens + reference), token-drift (generated-file freshness + undefined-token +
    broken-spec-link gate), plus an engine unit-test suite. Wired as yarn scripts.
  • pre-commit — token-audit (changed files) and token-drift (on style/spec changes) hooks.
  • CLAUDE.md — mandates reading specs/, using only tokens.css tokens, and running token-audit (zero errors) before commit.

Verification

  • yarn token-audit: 0 errors, 0 warnings
  • All 369 changed files compile under the project's LESS config (math: always) — 0 regressions vs base (verified by before/after compile-diff)
  • Codemod idempotent; every var(--om-/--ds-) reference is defined; 27 engine unit tests pass

Notes

  • variables.less remains the legacy LESS bridge (existing @var usage is still valid); prefer var(--om-*) for new work.
  • Contributors need pre-commit install once (same as existing Java/ruff hooks).

Type of change:

  • Bug fix
  • Improvement
  • New feature
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation

High-level design:

N/A — small change.

Tests:

Use cases covered

Unit tests

Backend integration tests

Ingestion integration tests

Playwright (UI) tests

Manual testing performed

UI screen recording / screenshots:

Not applicable.

Checklist:

  • I have read the CONTRIBUTING document.
  • My PR title is Fixes <issue-number>: <short explanation>
  • My PR is linked to a GitHub issue via Fixes #<issue-number> above.
  • I have commented on my code, particularly in hard-to-understand areas.
  • For JSON Schema changes: I updated the migration scripts or explained why it is not needed.
  • For UI changes: I attached a screen recording and/or screenshots above.
  • I have added tests (unit / integration / Playwright as applicable) and listed them above.

Copilot AI review requested due to automatic review settings July 24, 2026 20:10
@TeddyCr
TeddyCr requested a review from a team as a code owner July 24, 2026 20:10
@greptile-apps

greptile-apps Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Too many files changed for review. (411 files found, 100 file limit)

Bypass the limit by tagging @greptile-apps to review.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review this pull request because it exceeds the maximum number of files (300). Try reducing the number of changed files and requesting a review from Copilot again.

@github-actions

Copy link
Copy Markdown
Contributor

❌ PR checklist incomplete

This PR cannot be merged until the following are addressed on its linked issue:

  • No GitHub issue is linked. Link an issue in the Development section of the PR (or add Fixes #12345 to the description). For a same-org cross-repo issue, add Fixes open-metadata/<repo>#123 to the description.

The fields live on the linked issue in the Shipping project (open the issue → right sidebar → Projects). After you set them, re-run this check (or push a commit) — issue/project changes do not re-trigger it automatically.

Maintainers can bypass this check by adding the skip-pr-checks label.

@github-actions github-actions Bot added Ingestion safe to test Add this label to run secure Github workflows on PRs labels Jul 24, 2026
@TeddyCr TeddyCr added the skip-pr-checks Bypass PR metadata validation check label Jul 24, 2026
@TeddyCr
TeddyCr force-pushed the MINOR-Machine-Readable-Design-System branch from 964a892 to 7c38389 Compare July 24, 2026 20:11
Copilot AI review requested due to automatic review settings July 24, 2026 20:11

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review this pull request because it exceeds the maximum number of files (300). Try reducing the number of changed files and requesting a review from Copilot again.

@github-actions github-actions Bot added safe to test Add this label to run secure Github workflows on PRs and removed safe to test Add this label to run secure Github workflows on PRs labels Jul 24, 2026
Comment thread GROUPED_INCIDENTS_UI_CONTEXT.md Outdated
@github-actions

Copy link
Copy Markdown
Contributor

Jest test Coverage

UI tests summary

Lines Statements Branches Functions
Coverage: 65%
65.67% (76785/116918) 49.52% (46066/93018) 50.76% (13891/27364)

Copilot AI review requested due to automatic review settings July 24, 2026 20:37

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review this pull request because it exceeds the maximum number of files (300). Try reducing the number of changed files and requesting a review from Copilot again.

@github-actions github-actions Bot added safe to test Add this label to run secure Github workflows on PRs and removed safe to test Add this label to run secure Github workflows on PRs labels Jul 24, 2026
Copilot AI review requested due to automatic review settings July 24, 2026 21:48

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review this pull request because it exceeds the maximum number of files (300). Try reducing the number of changed files and requesting a review from Copilot again.

@github-actions github-actions Bot added safe to test Add this label to run secure Github workflows on PRs and removed safe to test Add this label to run secure Github workflows on PRs labels Jul 24, 2026
@TeddyCr
TeddyCr enabled auto-merge (squash) July 25, 2026 04:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Ingestion safe to test Add this label to run secure Github workflows on PRs skip-pr-checks Bypass PR metadata validation check

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants