Skip to content

feat(workbench): add the make-my-workbench flow and GitHub listing guide - #497

Merged
yaojin3616 merged 1 commit into
dataelement:v0.10.0from
cinderzhan:feat/workbench-submission-flow
Sep 21, 2026
Merged

yaojin3616 merged 1 commit into
dataelement:v0.10.0from
cinderzhan:feat/workbench-submission-flow

Conversation

@cinderzhan

@cinderzhan cinderzhan commented Sep 21, 2026

Copy link
Copy Markdown
Collaborator

Summary

Second of three PRs split out of #429. Stacked on #496 and synchronized with its Awesome catalog client. This PR adds the "make my workbench" path and connects its listing instructions to dataelement/awesome-dsh-workbench.

What's included

  • Make my workbench is a separate action beside the collection tabs. It guides users through Agent-assisted development, local installation and verification, then an optional Awesome listing pull request.
  • One author guide: docs/workbench-author-guide.zh.md covers development, local acceptance, first listing and later releases. scripts/build-workbench-guide.mjs generates the bundled copy, and test/workbench-guide-sync.test.mjs detects drift. Desktop serves the same Markdown at /api/desktop-workbenches/author-guide, with /development-guide kept as an alias.
  • Awesome submission prompt: the Agent publishes through npm, GitHub Release or source as supported, then opens the first-listing PR with one data/workbenches/owner__repo.yml. It may report submission only after obtaining a real PR URL, and listing only after the merged record appears in the public catalog.
  • Local submissions remain drafts: submissions.json v2 stores local-draft records separately from public Awesome results. Version-1 pending records migrate once with an exact metadata backup.
  • Catalog behavior preserved: public owner/repo identities remain separate from runtime workbenchId; remote entries are never falsely shown as installed, and entries without a loaded provider link to repository instructions.

Testing

  • npm ci --no-audit --foreground-scripts completed, including patch-package and postinstall
  • targeted catalog/client/state/navigation/submission/guide tests: 6 files, 122 tests pass
  • npm test: 119 files, 1091 tests pass
  • npm run typecheck, npm run build, and git diff --check pass

🤖 Generated with Claude Code

@yaojin3616
yaojin3616 force-pushed the feat/workbench-submission-flow branch from c05d9be to cb50c40 Compare September 21, 2026 15:52
@yaojin3616
yaojin3616 merged commit 37a4d87 into dataelement:v0.10.0 Sep 21, 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.

2 participants