Skip to content

build(web): sync KUI kaizen-ui skill on install - #1247

Merged
aahunt-nv merged 4 commits into
mainfrom
aahunt/kaizen-skills
Aug 12, 2026
Merged

build(web): sync KUI kaizen-ui skill on install#1247
aahunt-nv merged 4 commits into
mainfrom
aahunt/kaizen-skills

Conversation

@aahunt-nv

@aahunt-nv aahunt-nv commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Installing dependencies will now also sync the kaizen-ui skills to web/.agents/skills/kaizen-ui to give coding agents clear documentation for working with KUI.

Related Issue

Changes

  • web/package.json: add root sync-skills script and chain it into postinstall. The script resolves the design-system bin via pnpm --filter nemo-studio-ui exec kui-sync-skills --dir .agents || true, avoiding a brittle hardcoded node_modules path. It is best-effort (|| true): a sync failure still prints to stderr but does not fail pnpm install, since the skill is gitignored agent documentation rather than a build/runtime artifact.
  • web/.gitignore: keep the generated skill (.agents/skills/kaizen-ui/) ignored.
  • web/README.md, web/AGENTS.md: document that install syncs kaizen-ui from the design-system package and that pnpm sync-skills from web/ refreshes it after a package upgrade.

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with documentation updates
  • Documentation only
  • Contributor tooling or automation
  • CI, build, or test infrastructure

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification: install-time tooling change with no automated test surface; behavior verified manually against the real @nvidia/foundations-react-core@1.7.0 package (see Verification).
  • Tests not applicable — justification:
  • Documentation updated for user-visible behavior
  • Documentation not applicable — justification:

Verification

  • Pull request title follows the repository's Conventional Commit format
  • Every commit includes an appropriate Signed-off-by: trailer
  • uv run pre-commit run -a passes, or any blocked checks are identified below
  • Targeted tests pass, or tests are marked not applicable above
  • No secrets, API keys, or credentials are included

Targeted validation:

  • pnpm install from web/postinstall ran pnpm --filter nemo-studio-ui exec kui-sync-skills --dir .agents, which resolved the bin from studio's node_modules/.bin and reported kaizen-ui: already up-to-date (v4).
  • jq -e . web/package.json — valid JSON.
  • DCO audit over origin/main..HEAD — OK.

Summary by CodeRabbit

  • Documentation

    • Updated setup guidance to explain automatic synchronization of the Kaizen UI skill during installation.
    • Added instructions for manually refreshing the skill after package upgrades.
  • Chores

    • Added a command to synchronize the UI skill and integrated it into the installation process.
    • Excluded synchronized skill files from version control.

Run the design-system's sync-skills.mjs from the web root during postinstall so the kaizen-ui skill lands deterministically in web/.agents/skills regardless of where pnpm install is invoked. Removes the studio-package script that relied on INIT_CWD leaking through pnpm --filter. Documents the auto-sync in web/README.md and web/AGENTS.md.

Signed-off-by: Aaron Hunt <aahunt@nvidia.com>
@github-actions github-actions Bot added the build conventional-commit type label Aug 11, 2026
@aahunt-nv
aahunt-nv marked this pull request as ready for review August 11, 2026 23:11
@aahunt-nv
aahunt-nv requested review from a team as code owners August 11, 2026 23:11
@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: fc287f16-5d64-4920-8036-fdbad2aa7c01

📥 Commits

Reviewing files that changed from the base of the PR and between 2d403e8 and bcfcba7.

📒 Files selected for processing (1)
  • web/AGENTS.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • web/AGENTS.md

📝 Walkthrough

Walkthrough

The web package now synchronizes the KUI kaizen-ui skill during installation. The generated directory is gitignored. Setup documentation describes automatic synchronization and manual refresh commands.

Changes

KUI skill synchronization

Layer / File(s) Summary
Install-time skill synchronization
web/package.json, web/.gitignore, web/AGENTS.md, web/README.md
postinstall runs sync-skills after SDK generation. The script invokes skill synchronization and ignores failures. Documentation describes the generated, gitignored skill and manual refresh command.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: synchronizing the KUI kaizen-ui skill during web installation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch aahunt/kaizen-skills

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@web/AGENTS.md`:
- Line 13: Update the synchronization documentation in web/AGENTS.md to include
the concrete manual refresh command “pnpm sync-skills” run from the web
directory, while preserving the existing automatic synchronization guidance.

In `@web/package.json`:
- Around line 9-10: Update the sync-skills script in package.json to remove the
unconditional “|| true” fallback so synchronizer failures propagate and cause
installation to fail, preserving the documented requirement that
web/.agents/skills/kaizen-ui is available after install.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 3237f985-1a8f-4d5a-af2c-fc890429d79a

📥 Commits

Reviewing files that changed from the base of the PR and between d5e9e4e and 3b15546.

📒 Files selected for processing (4)
  • web/.gitignore
  • web/AGENTS.md
  • web/README.md
  • web/package.json

Comment thread web/AGENTS.md Outdated
Comment thread web/package.json Outdated
@github-actions

github-actions Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 32003/40624 78.8% 63.6%
Integration Tests 18554/38550 48.1% 20.8%

Replace the hardcoded node_modules path to sync-skills.mjs with
'pnpm --filter nemo-studio-ui exec kui-sync-skills', which resolves the
bin from studio's node_modules/.bin instead of a brittle internal path.

Signed-off-by: Aaron Hunt <aahunt@nvidia.com>
Match web/README.md by noting 'pnpm sync-skills' from web/ as the manual
refresh command for the kaizen-ui skill.

Signed-off-by: Aaron Hunt <aahunt@nvidia.com>
@aahunt-nv
aahunt-nv added this pull request to the merge queue Aug 12, 2026
Merged via the queue into main with commit d4b8171 Aug 12, 2026
57 checks passed
@aahunt-nv
aahunt-nv deleted the aahunt/kaizen-skills branch August 12, 2026 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build conventional-commit type

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants