For AI agents: the complete documentation index is available at https://silt-db.dev/llms.txt, the full documentation bundle is available at https://silt-db.dev/llms-full.txt, and this page is available as Markdown at https://silt-db.dev/contributing/release.md.

    Release preparation

    Silt is being evaluated for its first public release. The repository contains publishable npm workspaces, but the documentation does not assume that those package names have been published. Publishing packages is a separate maintainer action from pushing code or deploying documentation.

    Validate the intended application

    Try the exact package contents in a representative application before choosing a release version. For Teamplay, exercise document creation, subscriptions, updates, deletion, a database reopen, and the queries and aggregations the application actually uses. Include foreign-collection changes for live $lookup queries.

    Run the test matrix for the affected engines. For an Expo native release, execute the application on iOS and Android; bundle success alone is insufficient. For a MongoDB compatibility claim, run the differential suite on that particular server version and review the documented differences.

    Keep unverified environments and unsupported operators explicit in the release notes. An alpha release can accurately publish a useful, tested subset without claiming complete MongoDB or Mingo parity.

    Check package contents

    The public packages are:

    PackageDependency order
    @silt-db/compilerPublish first
    @silt-db/sqliteDepends on compiler
    @silt-db/sharedbDepends on compiler and sqlite; ShareDB is a peer

    The root workspace and @silt-db/native remain private. The optional native extension is built separately for its target platform.

    Inspect the tarballs without publishing:

    npm pack --dry-run --workspace @silt-db/compiler
npm pack --dry-run --workspace @silt-db/sqlite
npm pack --dry-run --workspace @silt-db/sharedb

    Each public package includes source, declarations, its README, and its MIT license. It excludes test fixtures, historical reports, runtime databases, documentation build output, and optional native binaries. Package metadata points to this repository and documentation site, and scoped publication is configured as public.

    Before publishing, choose versions deliberately and keep internal dependency versions consistent. Check the npm scope's ownership, install the resulting tarballs together in a clean consumer, and exercise both the runtime exports and TypeScript declarations. Only then publish the three packages in dependency order. There is no automatic npm publishing workflow in this repository.

    Documentation build and deployment

    The site uses the pinned Rspress version in package-lock.json, with / as its base path and https://silt-db.dev as its canonical origin. Preview the production build before changing deployment configuration:

    npm run docs:typecheck
npm run docs:build
npm run docs:preview

    The docs workflow validates documentation on pull requests and builds an artifact. Pushes affecting the site on main, or a manual workflow run on main, also deploy the artifact to GitHub Pages. Pull requests do not deploy.

    Pages and custom-domain configuration

    In the repository's Pages settings, set Build and deployment → Source → GitHub Actions. This is required before the first deployment. A workflow's GITHUB_TOKEN can deploy an enabled site; it cannot grant itself the administration access needed to enable Pages.

    The custom domain is silt-db.dev, configured in those same Pages settings. Keep the domain, siteOrigin, and base in rspress.config.ts aligned when changing hosting. GitHub manages the domain for this Actions deployment; a repository CNAME file is not required and is ignored for this publishing method. See GitHub's custom-domain documentation.

    Then run the docs workflow from GitHub Actions, or rerun its failed deployment job if the build artifact is still available and the hosting configuration has not changed. A domain or base-path change requires rebuilding the site first. The configured URL is silt-db.dev. A passing build is not proof that this URL is deployed; check the deployment job and open the site.

    The deployment has only contents: read, pages: write, and id-token: write. The normal test workflow remains read-only. Generated doc_build/ files are uploaded as an Actions artifact and are not committed to a branch. Public pages are sourced only from docs/; internal/ is outside the site's content root.

    Complete the release notes

    Describe the supported use cases, changes, tested engine versions, and meaningful limitations. Link to the compatibility matrix and explain any stored-format migration or API change. Replace prerelease installation instructions with verified npm installation commands only after the packages are available.