Skip to content

feat: derive component catalog from exact package tags - #597

Open
pontiac358 wants to merge 1 commit into
gravity-ui:mainfrom
pontiac358:feature/auto-import-component-docs
Open

feat: derive component catalog from exact package tags#597
pontiac358 wants to merge 1 commit into
gravity-ui:mainfrom
pontiac358:feature/auto-import-component-docs

Conversation

@pontiac358

@pontiac358 pontiac358 commented Feb 25, 2026

Copy link
Copy Markdown
Contributor

What changed

  • resolve exact @gravity-ui/* versions from installed packages instead of npm range strings;
  • discover component pages from src/components/<PascalCase>/README.md in each matching immutable v<version> GitHub tag;
  • generate an ignored runtime catalog during metadata preparation instead of committing bot-generated TypeScript files;
  • cache the catalog while schema, repositories, and exact package versions are unchanged;
  • keep hand-written landing configs as overrides for sandboxes, design guidance, RTL metadata, and other landing-only behavior;
  • preserve localized README-ru.md loading with the existing English fallback;
  • remove the scheduled workflow and bot branch updates.

The catalog does not read or depend on build/docs/INDEX.md or dist/docs/INDEX.md. Nested components, labs, hooks, and legacy lowercase directories remain explicit.

Generation fails without overwriting the previous catalog when GitHub rejects a request or returns a missing/truncated tree.

Validation

  • npm run test — 7 unit/integration/negative tests
  • npm run typecheck
  • npm run lint — 0 errors (existing repository warnings only)
  • npm run build
  • production browser checks for /components/uikit/avatar-stack and /components/uikit/table-column-setup

Architecture and extension rules are documented in docs/component-catalog.md.

@imsitnikov

Copy link
Copy Markdown
Collaborator

@dgaponov take a look plz

@dgaponov
dgaponov force-pushed the feature/auto-import-component-docs branch 3 times, most recently from d4049b0 to 30acf33 Compare August 12, 2026 15:14
@dgaponov dgaponov changed the title Feature/auto import component docs feat: derive component catalog from published package docs Aug 12, 2026
Co-authored-by: pontiac358 <pontiac358@gmail.com>
@dgaponov
dgaponov force-pushed the feature/auto-import-component-docs branch from 30acf33 to 1ec7024 Compare August 13, 2026 18:03
@dgaponov dgaponov changed the title feat: derive component catalog from published package docs feat: derive component catalog from exact package tags Aug 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants