Skip to main content

Releases and compatibility

Release governance lives beside the source code so the policies and the implementation change together. These GitHub documents are the canonical references:

  • Changelog — notable SDK, CLI, Scheduler, MCP, server, security, and documentation changes.
  • SDK compatibility policy — Semantic Versioning, supported runtimes, public entry points, and deprecations.
  • API versioning policy — /api/v1 compatibility rules and the boundary between public and operational endpoints.
  • Migration notes — database, configuration, CLI, API, media, and self-hosted upgrade steps.

The SDK and CLI are released independently with sdk-vX.Y.Z and cli-vX.Y.Z tags. The Scheduler and HTTP server should be deployed from one repository revision so their SDK behavior, OpenAPI documents, and database migrations stay aligned.

Published packages and hosted features​

The platform tables label current hosted app/core source separately from published SDK 1.3.1. The docs pin and check that npm release; a package version in an unreleased checkout is not evidence that its code is on npm. Local CLI 1.3.1 uses the released SDK, while CLI posts to Scheduler-connected accounts execute on the hosted app.

Known differences at this reference baseline:

  • Threads: the hosted app/core supports up to twenty media items and mixed carousels. SDK 1.3.1 permits one item and no mixed media.
  • YouTube playlists: the hosted app/core rejects playlistId; SDK 1.3.1 attempts playlist insertion, which can fail after upload. Omit the option in portable examples.

Do not assume npm install includes newer hosted capabilities. Check your installed package version and its tagged release notes. Self-hosted behavior follows the revision you deploy. Maintainers must publish a new SDK release, update the docs' exact dependency, and regenerate the published snapshot before removing these distinctions.

Current compatibility baseline​

  • @simple-post/sdk 1.x and @simple-post/cli 1.x require Node.js 20 or newer.
  • SDK 1.x publishes ESM, CommonJS, and TypeScript declarations.
  • Public HTTP integration endpoints use /api/v1.
  • Self-hosted Scheduler upgrades apply checked-in Prisma migrations with yarn prisma migrate deploy before the new application starts.

Do not rely on an old documentation subdomain. The public GitHub repository, package READMEs, checked-in OpenAPI documents, and the pages in this site are the supported documentation sources.

Documentation release checklist​

  • Export both API references, billing facts, and platform rules from the core checkout being released using yarn docs:export in core. The checked-in docs-source.json records its revision and source hash.
  • Run yarn sync:sdk and yarn check:sdk to verify the pinned npm reference and executable quickstart independently of the core checkout.
  • Update affected user guides and integration examples. Keep hosted account setup separate from developer credentials and deployment-specific capabilities.
  • Run docs type checking, a production build, and yarn check:workspace with sibling core and website-social checkouts. The website must be built for rendered trial CTA verification.
  • Verify desktop and mobile help links, search, assistant setup, and expired-trial recovery wording. Opening a plan preference must never start checkout automatically.
  • Publish matching app, landing, and docs revisions. Verify https://docs.simplepost.social canonical URLs and path-preserving redirects from the former domain.