tuix-webcomponents 0.0.25 → 0.0.26

package/README.md

@@ -12,8 +12,8 @@ npm i tuix-webcomponents
 
 ### Webbundle version
 
-Webbundle Link: https://tuix-webcomponents.s3.eu-central-1.amazonaws.com/build-bf814e0@0.89.0.js  
-Styles Link: https://tuix-webcomponents.s3.eu-central-1.amazonaws.com/build-bf814e0@0.89.0.css
+Webbundle Link: https://tuix-webcomponents.s3.eu-central-1.amazonaws.com/build-22f6faf@0.91.1.js  
+Styles Link: https://tuix-webcomponents.s3.eu-central-1.amazonaws.com/build-22f6faf@0.91.1.css
 
 ### React
 
@@ -88,8 +88,10 @@ and a page per component with live previews of every variant, in English and
 German. Pages are MDX files in `docs/content/docs/` (`*.mdx` English,
 `*.de.mdx` German), ordered by `meta.json` and `meta.de.json`.
 
-See `docs/src/modules/docs/README.md` for how the site is put together, and
-[the contributing page](docs/content/docs/contributing.mdx) for the workflow.
+The site is public-facing: it shows and documents the components, and carries no
+contributor workflow. That lives here and in
+`docs/src/modules/docs/README.md`, which covers how the site is put together —
+content locations, the live previews, the framework selector and the locales.
 
 ## Building the package
 
@@ -120,6 +122,37 @@ tokens, and `tsc-esm-fix` adds the `.js` extensions Node's ESM resolver needs.
 cannot ship a stale `dist/`. `npm run publish:local` packs the same output into
 a linkable `local/` folder for trying it in another project.
 
+## Releases
+
+Releases are automatic, from CircleCI. `bin/publish.sh` takes the newest
+`feat(`, `feat!(` or `fix(` subject out of the last ten commits and derives the
+version from it:
+
+| Commit prefix | Bump  |
+| ------------- | ----- |
+| `feat!(`      | major |
+| `feat(`       | minor |
+| anything else | patch |
+
+Commit subjects are linted by commitlint against
+[Conventional Commits](https://www.conventionalcommits.org), so the prefix is
+not optional.
+
+The branch decides the dist-tag, and the two paths differ:
+
+| Branch       | Dist-tag  | Version                                       | Also does                                                                   |
+| ------------ | --------- | --------------------------------------------- | --------------------------------------------------------------------------- |
+| `master`     | `latest`  | bumped from the commit subject, per the table | uploads the web bundle to S3, rewrites the two links below, tags `v<version>` |
+| anything else| `staging` | always a patch bump off `staging`             | uploads the web bundle to S3                                                |
+
+Both paths build the bundle as `build-<short hash>@<version>.{js,css}` and
+upload it, so every deployment is immutable. Only `latest` rewrites the
+`Webbundle Link:` and `Styles Link:` lines under [Usage](#usage) and commits
+them — which is why those two lines are the one place in the repository that
+tracks the current bundle. `docs/scripts/build-bundle-links.ts` reads them at
+docs build time rather than copying the URLs into a page, so the documentation
+cannot fall a release behind.
+
 ## Linting and formatting
 
 To scan the project for linting and formatting errors, run
@@ -152,11 +185,11 @@ That writes `dist/storybook`, which is where the deployed site serves it from.
 The site root is the documentation, and the Storybook sidebar brand links back
 to it. `scripts/build.sh` is what assembles both into `dist/` for CI.
 
-Three builds, three folders, so none of them clears another: the site into
-`dist/` (`scripts/build.sh` — Storybook under `dist/storybook`, the docs export
-at the root), the npm package into `package-build/` (`npm run build`), and the
-dev compile into `build/` (`npm start`). `dist/` is reused for the package only
-by `npm run stage:package`, which runs in the publish job.
+Two builds, two folders, so neither clears the other: the site into `dist/`
+(`scripts/build.sh` — Storybook under `dist/storybook`, the docs export at the
+root) and the npm package into `package-build/` (`npm run build`). `dist/` is
+reused for the package only by `npm run stage:package`, which runs in the
+publish job.
 
 
 ## Tooling configs
@@ -164,12 +197,3 @@ by `npm run stage:package`, which runs in the publish job.
 For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
 
 If you customize the configuration a lot, you can consider moving them to individual files.
-
-## Local Demo with `web-dev-server`
-
-```bash
-npm start
-```
-
-To run a local development server that serves the basic demo located in `demo/index.html`
-