Skip to content

Open-source release readiness - #12

Merged
joaner merged 6 commits into
mainfrom
feat/open-source-readiness
Aug 4, 2026
Merged

Open-source release readiness#12
joaner merged 6 commits into
mainfrom
feat/open-source-readiness

Conversation

@joaner

@joaner joaner commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR completes the open-source release readiness work in two commits on top of main.

Commit 1 — Prepare stable open-source release (f92fa65)

  • Hardens LeRobot v2/v3 compatibility, freezes the public viewer API surface, and wires in release-quality gates.
  • Adds CI/security/release workflows (CodeQL, dependency review, Scorecard, docs pages, nightly, release dry-run), API Extractor reporting, bundle-size checks, and npm-consumer verification scaffolding.
  • Expands documentation (architecture, compatibility, deployment, migration, privacy, troubleshooting), governance files, examples (Vite + Next.js), and broad test coverage across core, platform, browser, and integration suites.

Commit 2 — Finish open-source release readiness (f3266e7)

  • Simplifies package/build layout: moves cssScopePlugin to scripts/vite/, introduces public-api.ts and errorDetails.ts, and trims Docker/httpd surface.
  • Isolates consumer gates under tests/npm-consumer/ (Vite/React, Next App Router, Docker tarball install) so publish-time verification stays separate from library sources.
  • Upgrades GitHub Actions pins across CI, nightly, release, CodeQL, docs, and security workflows; adds Dependabot coverage.
  • Adds bilingual docs and templates (.zh-CN.md), VitePress locale routing, and scripts/check-docs-i18n.mjs with exception tracking.
  • Lands final performance and accessibility acceptance updates in browser/frontend specs.

Local verification (pre-push)

  • 229 unit/coverage tests (Vitest)
  • 4 official LeRobot compatibility fixtures
  • 17 Chromium full browser tests
  • 42 cross-browser smoke tests
  • Vite + Next.js tarball npm-consumer installs
  • Docker consumer gate (tests/npm-consumer)
  • docs/i18n parity check
  • npm audit (production deps)
  • actionlint on workflows
  • bundle size + SBOM generation

Test plan

  • Full local gate suite above (only non-blocking API Extractor TS5.9→TS6 analyzer notice observed)
  • CI required checks green on this PR
  • Squash merge into main after review/merge gates pass

joaner added 6 commits August 4, 2026 17:54
Harden LeRobot compatibility, freeze the viewer API, and add the quality, security, documentation, and release gates required for a reliable 1.0 launch.
Simplify package and build layout, isolate npm-consumer gates under
tests/npm-consumer, upgrade GitHub Actions pins, add bilingual docs with
i18n checks, and land final performance and accessibility acceptance.
Mock remote archive fetches in archive-datasource tests to prevent
late ENOTFOUND rejections on CI, and skip SARIF upload or dependency
review when GitHub Advanced Security is unavailable on private repos.
Grant actions:read to CodeQL so overlay database cache lookup works on
pull requests, and format archive-datasource tests for CI format:check.
Exercise the remaining shouldStartAutoplay early-return paths so branch
coverage stays above the 70% threshold on slower CI runners.
The quality job runs verify-npm-consumer with Playwright, so install the
Chromium browser before check:package to avoid missing executable failures.
@joaner
joaner merged commit b079515 into main Aug 4, 2026
6 checks passed
@joaner
joaner deleted the feat/open-source-readiness branch August 4, 2026 11:07
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.

1 participant