Releasing to npm ​
LokulMem uses Changesets for safe, predictable versioning and release automation.
Release model ​
- Contributor adds a changeset in their PR.
- After merge to
main, the Release workflow opens/updates a "release package(s)" PR. - Merging that PR bumps versions and updates changelog files.
- Workflow publishes to npm after quality gates pass.
Contributor flow ​
bash
npm run changesetChoose one bump type:
patch: bug fix, no API breakminor: backward-compatible featuremajor: breaking change
Scripts ​
npm run changeset- create release note filenpm run version-packages- apply version bumps from changesetsnpm run release- publish packages with Changesets
Manual setup required once ​
- npm account access
- ensure you are maintainer of
@lokul/lokulmempackage name
- ensure you are maintainer of
- npm trusted publishing (recommended)
- in npm package settings, connect GitHub repository
Pouryaak/LokulMem - allow GitHub Actions trusted publishing
- in npm package settings, connect GitHub repository
- GitHub Actions permission
- keep workflow
id-token: writeenabled
- keep workflow
- Optional fallback token
- add
NPM_TOKENin GitHub repo secrets (only if not using trusted publishing)
- add
Safety gates before publish ​
Release workflow runs:
npm run cinpm run eval:memory:Cnpm run verify:package
If any step fails, publish is blocked.