MAKS-IT/maksit-webui
2
0
Fork 0
mirror of https://github.com/MAKS-IT-COM/maksit-webui.git synced 2026-08-15 09:58:09 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity
55611f8c3b
maksit-webui/assets/docs/NPM_PUBLISH.md
Maksym Sadovnychyy 25ae18bab6
Some checks failed
Storybook tests / storybook-tests (push) Has been cancelled
Details
(feature): release as unified npm package @maks-it.com/webui, deepDelta fixes
2026-07-07 18:44:01 +02:00

2.3 KiB
Raw Blame History

Publishing @maks-it.com/webui to npm

The library is published under the @maks-it.com scope to registry.npmjs.org, managed from the maks-it.com npm org.

Published package:

Package npm
@maks-it.com/webui https://www.npmjs.com/package/@maks-it.com/webui

Note: @maks-it.com/webui-contracts, @maks-it.com/webui-core, and @maks-it.com/webui-components were merged into @maks-it.com/webui starting at 0.4.0. Migrate host apps to the single package.

One-time npm setup

  1. Sign in at https://www.npmjs.com/ with the maks-it.com org account.
  2. Confirm the @maks-it.com scope exists under Packages.
  3. Create an Automation token (recommended) or Granular Access token with Publish on @maks-it.com/*:
  4. Store the token for release tooling:
    • CI / release engine: set environment variable Npm (logical secret name in scriptSettings.json).
    • Local one-off publish: npm login or a user-level ~/.npmrc entry: 
      //registry.npmjs.org/:_authToken=YOUR_TOKEN

Scoped packages must use --access public (already configured in package publishConfig).

Manual publish

From the repo root:

cd src
npm ci
npm run build
npm publish -w @maks-it.com/webui --access public

Verify:

npm view @maks-it.com/webui version

Release pipeline (recommended)

Use utils\Invoke-ReleasePackage-Single.bat (or pwsh utils\engines\release\Invoke-ReleasePackage.ps1):

  1. Bump version in src/package.json (or tag drives NpmReleaseVersion).
  2. Tag HEAD with exact semver, e.g. git tag v0.4.0 && git push origin v0.4.0.
  3. Set $env:Npm and run the release engine.

utils\engines\release\scriptSettings.json runs NpmReleaseVersion, NpmBuild, ReleasePublishGuard, optional GitHub, then NpmPublish.

After publish — Certs UI / Vault

In each WebUI app (MaksIT.WebUI/package.json):

"@maks-it.com/webui": "^0.4.0"

Then refresh the lockfile:

cd src/MaksIT.WebUI
npm install

Docker builds use npm ci from the lockfile; no sibling maksit-webui clone is required in the image context.