Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (26 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 1.58 KB
Raw

Contributing to Jarspec

Releasing the libraries

The libraries live in this Bun workspaces monorepo and are published to npm independently. Each package is built with tsdown into a dual ESM + CommonJS bundle (.mjs/.cjs + .d.mts/.d.cts). dist/ is git-ignored and rebuilt automatically at publish time by each package's prepack script, so there is nothing built to commit.

1. Bump the version

Update the version everywhere and keep the values in sync:

  • the package versions in packages/js-client/package.json, packages/js-server/package.json (and the root package.json, which tracks the spec version)
  • the spec version literal the libraries emit — common/@types/CommonResponse.ts and its mirrored copies under each packages/*/src/common, the version value in each packages/*/src/index.ts, and the examples + Latest jarspec version at the bottom of the README

2. Build and validate

bun install
bun run workspace:build   # builds both packages with tsdown
bun run lint:pkg          # publint - validates the published package shape

3. Publish

Each command runs the package's prepack first (which rebuilds dist/); the files field then ships only dist/ in the tarball:

npm login                                  # one-time; needs publish rights to the @devleaf-labs scope
bun publish --cwd packages/js-client
bun publish --cwd packages/js-server

Both packages set publishConfig.access: "public", so the scoped packages are published publicly.

4. Tag the release

git tag v2.0.0
git push --tags