@emporix/component-library 1.10.0 → 1.11.0

package/README.md

@@ -1005,6 +1005,7 @@ npm run storybook
 - `npm run test:coverage` - Run tests with coverage
 - `npm run storybook` - Start Storybook
 - `npm run build-storybook` - Build Storybook
+- `npm run build:pages` - Build showcase and Storybook for GitHub Pages
 - `npm run lint` - Run ESLint
 - `npm run lint:fix` - Fix ESLint issues
 - `npm run type-check` - Run TypeScript type checking
@@ -1054,6 +1055,54 @@ The build output includes:
 - TypeScript declarations (`index.d.ts`)
 - CSS styles (`styles.css`)
 
+## Publishing
+
+Releases are automated via GitHub Actions when you push a version tag. Pushing a tag triggers:
+
+1. **npm publish** — builds the library (`npm run build:lib`) and publishes `@emporix/component-library` to the npm registry
+2. **GitHub Pages** — builds the showcase app (`npm run dev`) and static Storybook, then deploys both sites
+
+### Live sites
+
+After a successful release:
+
+| Site               | URL                                                    |
+| ------------------ | ------------------------------------------------------ |
+| Showcase (dev app) | https://emporix.github.io/component-library/           |
+| Storybook          | https://emporix.github.io/component-library/storybook/ |
+
+### One-time setup
+
+In the GitHub repository, go to **Settings → Pages** and set **Source** to **GitHub Actions**.
+
+npm publishing uses [trusted publishing](https://docs.npmjs.com/trusted-publishers) (OIDC) — ensure the npm package is configured to trust this repository’s `publish.yml` workflow.
+
+### Release steps
+
+1. **Bump the version** in `package.json` (and `package-lock.json` via `npm install` if needed):
+   - **Minor** (`1.7.1` → `1.8.0`) for backward-compatible features
+   - **Major** (`1.7.1` → `2.0.0`) for breaking changes
+   - **Patch** (`1.7.1` → `1.7.2`) for bug fixes only
+2. **Merge** the version bump to the default branch.
+3. **Create and push a tag** that matches `package.json` exactly (prefix with `v`):
+
+```bash
+# Example: package.json version is 1.10.0
+git tag v1.10.0
+git push origin v1.10.0
+```
+
+The tag must match the format `v{semver}` (e.g. `v1.2.3`). CI rejects tags that do not match `package.json`.
+
+### Preview GitHub Pages locally
+
+```bash
+npm run build:pages
+npx serve gh-pages
+```
+
+Open http://localhost:3000/component-library/ (showcase) and http://localhost:3000/component-library/storybook/ (Storybook).
+
 ## Code Formatting
 
 This project uses Prettier for consistent code formatting. The configuration is defined in `.prettierrc`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emporix/component-library",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "description": "A React component library for Emporix projects",
   "type": "module",
   "main": "./dist/index.umd.js",
@@ -38,6 +38,9 @@
     "test:coverage": "vitest --coverage",
     "storybook": "storybook dev -p 6006",
     "build-storybook": "storybook build",
+    "build:showcase:pages": "VITE_BASE_PATH=/component-library/ npm run build",
+    "build-storybook:pages": "STORYBOOK_BASE_PATH=/component-library/storybook/ npm run build-storybook",
+    "build:pages": "npm run build:showcase:pages && npm run build-storybook:pages && node scripts/assemble-pages.mjs",
     "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "lint:fix": "eslint . --ext ts,tsx --fix",
     "type-check": "tsc --noEmit",