Skip to content

Validate javadoc snippets, simplify playground bindings, and allow local CN1 sources for registry generation#4665

Closed
liannacasper wants to merge 2 commits intomasterfrom
codex/fix-playground-component-recognition-error-76axjk
Closed

Validate javadoc snippets, simplify playground bindings, and allow local CN1 sources for registry generation#4665
liannacasper wants to merge 2 commits intomasterfrom
codex/fix-playground-component-recognition-error-76axjk

Conversation

@liannacasper
Copy link
Copy Markdown
Collaborator

Motivation

  • Ensure JavaDoc snippet extraction is validated before generating docs and fail fast on long-running checks.
  • Simplify BeanShell/playground runtime by binding Display and UIManager to their instances and ensure Component is available without explicit imports.
  • Allow generate-cn1-access-registry.sh to use local Codename One sources for faster iteration and make the default behavior explicit in the tools README.

Description

  • Updated .github/scripts/build_javadocs.sh to add run_with_timeout, invoke validate-extracted-javadoc-snippets.sh (with a 300s timeout) and propagate timeout/exit status with a clear message.
  • Modified PlaygroundRunner.java to set Display and UIManager to Display.getInstance() and UIManager.getInstance() respectively, add Component binding and import, and removed the previous resolver helper methods.
  • Reworked scripts/cn1playground/tools/generate-cn1-access-registry.sh to support CN1_ACCESS_USE_LOCAL_SOURCES=true for scanning local source roots, keep the default of using release source jars, add robust download/extract error handling, and pass CN1_SOURCE_ROOTS into the registry generator when appropriate.
  • Updated scripts/cn1playground/tools/README.md to document the default behavior and the CN1_ACCESS_USE_LOCAL_SOURCES override.
  • Adjusted smoke tests in PlaygroundSmokeHarness.java by removing two CSS-related smoke checks and adding smokeComponentTypeResolvesWithoutExplicitImport to validate implicit Component resolution.

Testing

  • Ran the playground smoke harness (PlaygroundSmokeHarness) and related unit tests; the modified smoke tests completed successfully.
  • Exercised generate-cn1-access-registry.sh logic paths through code review and added runtime checks for missing local roots and download/extract failures (script exits on error as intended).

Codex Task

…-error-76axjk

Signed-off-by: liannacasper <67953602+liannacasper@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown

Cloudflare Preview

@github-actions
Copy link
Copy Markdown

✅ Continuous Quality Report

Test & Coverage

Static Analysis

Generated automatically by the PR CI workflow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant