Publishing
Imperium is prepared for npm publication under the MIT license.
Prerequisites
- Node.js 20+
- pnpm 10+
- npm token with publish permissions
Local Prepublish Checklist
From repo root:
bash
pnpm install
pnpm run typecheck
pnpm run build
pnpm packPublish from Local Machine
bash
pnpm publish --access public --no-git-checksGitHub Workflow: Unified Publish
.github/workflows/publish.yml handles package publish and docs deploy.
- Trigger: tag push
v*.*.*
It performs:
pnpm installtypecheckbuildpublishto npmbuild+ deploy docs to GitHub Pages
Required secret:
NPM_TOKEN
The workflow sets DOCS_BASE=/<repo>/ automatically for project pages.
Versioning Model
Package version is derived from the git tag during CI publish:
- update
CHANGELOG.md - create and push tag (
vX.Y.Z) - workflow syncs
package.jsonversion to the tag and publishes