@brighterly/lib-core-types

Publishing New Versions

Publishing is automatic and CI-only. .github/workflows/publish.yml has two jobs: validate installs with the frozen lockfile and builds (strict tsc) on every PR and push to main; publish runs nothing of its own — on a push to main whose package.json version npm does not have yet, it takes the dist/ that validate built and runs npm publish. So a release is a version bump that reaches main:

1. Bump the version Use one of the following commands to update package.json and create a git tag:

   pnpm version patch   # 1.0.0 -> 1.0.1 (bug fixes)
   pnpm version minor   # 1.0.0 -> 1.1.0 (new features)
   pnpm version major   # 1.0.0 -> 2.0.0 (breaking changes)
   

2. Push to main (directly or through a PR):

   git push
   

3. The npm release is created automatically.

A push that does not change the version skips the publish job. Do not npm publish from a laptop: dist/ is gitignored, and only validate builds the one that ships.

Pre-Commit Hook

run:

chmod +x _tools/git/pre-push
ln -s ../../_tools/git/pre-push .git/hooks/pre-push

Dependencies

Create .env:

cp .env.example .env

Edit .env and add NPM_FORTAWESOME_ACCESS

Install deps:

make install