Skip to content

Release Completion Audit

Audience: maintainers deciding whether Roomful is release-complete.

This audit maps the launch requirements from Roomful-Issues-Sprints.pdf, especially EP-09 #054 through #057, to current proof commands and release evidence.

Roomful has local release evidence for the current JavaScript/TypeScript package set, and v2.0.0 is publicly release-complete across npm, GitHub Release, Docker Hub, docs, and demo surfaces.

All ten public npm packages (@roomful/angular, @roomful/core, @roomful/cursors, @roomful/devtools, @roomful/next, @roomful/react, @roomful/relay, @roomful/solid, @roomful/svelte, and @roomful/vue) are covered by package tarball verification. Publish smoke now packs all ten packages and runs clean-install consumers for core, React, Vue, Svelte, Solid, Angular, Next auth, cursors, and devtools.

RequirementCurrent evidenceState
Docs site built with getting started, API reference, playground, community links, dark mode, search, versioned docs, and mobile layoutpnpm test:docs, pnpm docs:snippets, docs workflow and apps/docs sourcesLocally ready; public URL still must load
Demo app with shared canvas, live cursors, presence, mobile touch, cleanup, and social sharingpnpm test:integration:demo, demo workflow and apps/demo testsLocally ready; public URL still must load
End-to-end tests cover presence, cursors, state, awareness, events, reconnection, and real browserspnpm test:integration, pnpm test:integration:react, pnpm test:integration:demo, pnpm test:docsLocally verified
Packages published to npm under @roomfulpnpm release:verify-public -- --tag v<release>Current npm checks pass for all ten public packages
GitHub Release tagged with changelogpnpm release:verify-public -- --tag v<release>Current v2.0.0 GitHub Release API check passes
Relay Docker image publishedpnpm release:verify-public -- --tag v<release>Current v2.0.0 immutable Docker Hub tag check passes
Show HN, blog, social, and Discord launch tasks completeLaunch kitPrepared, not posted
npm weekly downloads baseline recordedpnpm release:downloads-baselineCommand available; final baseline must be recorded after publish

Run these before tagging:

Terminal window
pnpm format:check
pnpm lint
pnpm verify:tsconfig-extends
pnpm typecheck:all
pnpm test
pnpm docs:snippets
pnpm build
pnpm test:types
pnpm verify:package-types
pnpm smoke:publish
pnpm test:integration
pnpm test:integration:react
pnpm test:integration:demo
pnpm test:docs

Relay release proof:

Terminal window
pnpm --filter @roomful/relay build
pnpm --filter @roomful/relay test
node packages/relay/dist/cli.js --version
docker build -t roomful-relay:test .

Run these after the release workflow succeeds:

Terminal window
pnpm release:verify-public -- --tag v<release>
pnpm release:downloads-baseline

release:verify-public checks:

  • npm registry entries for every public @roomful/* package at the current package versions
  • GitHub Release for the release tag
  • Docker Hub tag for erayatesdev/roomful matching the release tag without the leading v
  • https://docs.roomful.dev
  • https://demo.roomful.dev

The latest public verifier run for v2.0.0 passes:

  • npm @roomful/* registry checks return 200 for all ten public packages at their current versions
  • GitHub Release v2.0.0 returns 200
  • Docker Hub erayatesdev/roomful:2.0.0 returns 200
  • Docker Hub erayatesdev/roomful:latest returns 200
  • docs and demo public URLs return 200

Dart and Flutter packages are published on pub.dev as alpha releases: roomful (v0.1.0-alpha.10) and roomful_flutter (v0.1.0-alpha.4).

  1. Review the dirty worktree and stage only release-intended changes.
  2. Commit the release-ready worktree.
  3. Push the release commit to main through the normal review path.
  4. Configure GitHub repository secrets: NPM_TOKEN, DOCKERHUB_USERNAME, and DOCKERHUB_TOKEN.
  5. Push the intended v* tag from the release commit.
  6. Wait for .github/workflows/release.yml to publish npm packages, Docker image, and GitHub Release.
  7. Deploy or verify docs, demo, and Storybook public surfaces.
  8. Run pnpm release:verify-public -- --tag v<release>.
  9. Run pnpm release:downloads-baseline.
  10. Publish launch announcements using Launch Kit.

The project should only be marked release-complete after every public verifier check passes and launch links are recorded.