SQLR-64: publish sqlrite-notes example to npm#144
Merged
Conversation
Lets users `npx sqlrite-notes init <dir>` on a fresh machine — the parent ticket's (SQLR-40) DoD that the shipped example didn't meet because it still required cloning the repo. - `examples/nodejs-notes/package.json`: drop `private: true`; bump to 0.10.1 (lockstep with engine); bump `@joaoh82/sqlrite` pin to ^0.10.1; add `files` whitelist + `publishConfig` (public, OIDC provenance). - `examples/nodejs-notes/src/cli.mjs`: read VERSION from package.json so the lockstep bump propagates automatically. - `examples/nodejs-notes/README.md`: Install / Run sections lead with `npx sqlrite-notes init <dir>`; clone path kept under Development. - `scripts/bump-version.sh`: add the example's package.json to JSON_FILES + new NPM_DEP_PIN_FILES sweep that rewrites the `@joaoh82/sqlrite` caret pin in lockstep; verification block extended to catch missed pins. - `.github/workflows/release.yml`: new `publish-notes-example` job (mirrors publish-nodejs — OIDC trusted publishing, sigstore provenance, `--access public`); `sqlrite-notes-v$V` tag added to tag-all; wired into finalize.needs + umbrella release body. - `docs/release-plan.md`: product-tag table row + lockstep note; bumped manifest list to include the example's package.json. - `docs/release-secrets.md`: §3 retitled "three packages"; new §3c documents the placeholder-publish + trusted-publisher bootstrap for unscoped `sqlrite-notes` (with `@joaoh82/sqlrite-notes` fallback if the registry rejects the unscoped name). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes SQLR-64. Follow-up from SQLR-40 / #141 — gets the example to the original DoD of
npx sqlrite-notes init <dir>on a fresh machine, no clone, no Rust toolchain.Summary
"private": trueand addsfiles+publishConfig(OIDC provenance, public access) toexamples/nodejs-notes/package.json; bumps to 0.10.1 + engine pin to^0.10.1so the package ships in lockstep with the engine.publish-notes-examplejob torelease.ymlmirroringpublish-nodejs(OIDC trusted publishing, sigstore provenance,--access public). Sequenced afterpublish-nodejsso the example resolves its@joaoh82/sqlritepin against the version just put on npm.scripts/bump-version.shwith the example'spackage.jsonand a new@joaoh82/sqlritecaret-pin sweep + verification, symmetric to the existing inter-workspace Cargo path-dep sweep.npx sqlrite-notes init <dir>; keeps the clone path documented under Development.docs/release-secrets.md §3c) for the one-time npm placeholder + trusted-publisher setup. Documents the@joaoh82/sqlrite-notesfallback if the unscoped name is rejected.Package name
Going with unscoped
sqlrite-notesper the ticket —notesisn't a confusable suffix of any existing popular package. If thenpm publishof the bootstrap placeholder is rejected by the similarity check, fall back to@joaoh82/sqlrite-notes; the docs spell that out.Out of scope
docs/release-secrets.md).@joaoh82/sqlriteitself — unchanged.sqlrite-mcpto npm — stays a Rust binary on crates.io + GitHub Releases.Test plan
bash -n scripts/bump-version.shyaml.safe_loadon.github/workflows/release.yml./scripts/bump-version.sh 0.99.0dry-run → all 13 manifests bump +@joaoh82/sqlritepin moves to^0.99.0; verification ✓; reverted.npm testinexamples/nodejs-notes/→ 40/40 pass.npm pack --dry-run→ 13 files, 23.1 kB packed (README.md + bin/ + src/ + package.json). No test fixtures, no node_modules.node bin/sqlrite-notes.mjs helpprints0.10.1(VERSION reads from package.json).npm install ./sqlrite-notes-0.10.1.tgzinto a scratch dir,./node_modules/.bin/sqlrite-notes helpruns.npx sqlrite-notes@latest init <dir>end-to-end — needs the package on npm (post-merge smoke).npm audit signaturesagainst a published version — same.🤖 Generated with Claude Code