@ids-group-ltd/ids-design-system 0.1.0 → 0.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 IDS Group Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,6 +2,8 @@
 
 Angular component library, design tokens and themes for IDS Group products.
 
+📖 **Live docs & component showcase:** https://ids-ds.proto.ids-group.co.uk/
+
 - 45+ standalone components (buttons, forms, overlays, navigation, data display)
 - Three-tier token architecture: palette → semantic theme → geometry/typography/motion tokens
 - Bundled fonts (Mulish, JetBrains Mono) — no external font CDN required
@@ -68,7 +70,8 @@ export class ExampleComponent {}
 
 ## Development
 
-This repo contains the library (`src/`) and a documentation app (`ds-docs/`).
+This repo contains the library (`src/`) and a documentation app (`ds-docs/`). The
+docs app is published live at https://ids-ds.proto.ids-group.co.uk/.
 
 ```bash
 npm run build        # build the library into dist/ds
@@ -82,24 +85,46 @@ Releases follow [SemVer](https://semver.org): `fix` → patch, new backwards-com
 features → minor, breaking changes (API or visual) → major. A new Angular major
 always means a new package major. See `CHANGELOG.md` for history.
 
-Publishing runs in CI (Bitbucket Pipelines): pushing a `vX.Y.Z` tag builds the
-library and publishes it to npm. To cut a release, with a clean working tree:
+Before releasing, add your notes to the `## Unreleased` section of `CHANGELOG.md`
+on `main`. Then release one of two ways.
+
+### Option A — one-click in Bitbucket (recommended)
+
+In the Bitbucket UI: **Pipelines → Run pipeline → branch `main` →** pick
+`release-patch`, `release-minor`, `release-major`, or `release-beta`. CI bumps the
+version, stamps the CHANGELOG, commits, and pushes `main` + a `vX.Y.Z` tag — no
+local tooling needed. That tag push then triggers the `Publish to npm` pipeline,
+which builds and publishes (so you'll see two runs: the release, then the publish).
+`## Unreleased` must be filled first; preflight fails the pipeline early otherwise.
+
+### Option B — locally
+
+With a clean, in-sync `main`:
 
 ```bash
 npm run release:patch   # 0.1.0 -> 0.1.1  bugfixes
 npm run release:minor   # 0.1.0 -> 0.2.0  new components/inputs/tokens
 npm run release:major   # 0.x   -> 1.0.0  breaking changes
+npm run release:beta    # 0.2.0 -> 0.2.1-beta.0  pre-release
 
 git push origin main --follow-tags   # the tag push triggers CI publish
 ```
 
-Each `release:*` bumps the version and creates a `release: x.y.z` commit plus a
-`vX.Y.Z` git tag locally — it does **not** publish. The tag push to Bitbucket
-runs `bitbucket-pipelines.yml`, which builds and publishes `dist/ds`. Add a
-`CHANGELOG.md` entry before releasing.
+Each `release:*` runs preflight checks first (must be on a clean, in-sync `main`
+with a non-empty `## Unreleased` CHANGELOG section), bumps the version, stamps the
+CHANGELOG (`## Unreleased` → `## x.y.z — date`, opening a fresh Unreleased), and
+creates a `release: x.y.z` commit plus a `vX.Y.Z` git tag locally — it does **not**
+publish. The tag push to Bitbucket runs `bitbucket-pipelines.yml`, which builds
+`dist/ds` and publishes it through `infrastructure/scripts/publish.sh`. That script
+refuses to publish if the tag does not match the built version or if the version is
+already on npm.
+
+Bypass preflight in emergencies with `SKIP_PREFLIGHT=1 npm run release:patch`.
 
-CI auth uses a Secured repository variable `NPM_TOKEN` (npm granular access
-token, read+write on `@ids-group-ltd`, "Bypass 2FA" enabled).
+CI auth uses two Secured repository variables: `NPM_TOKEN` (npm granular access
+token, read+write on `@ids-group-ltd`, "Bypass 2FA" enabled) for publishing, and —
+for the one-click pipelines only — `RELEASE_TOKEN`, a Bitbucket Repository Access
+Token with `repository:write` used to push the bump commit and tag back to `main`.
 
 Manual publish (fallback, requires an authenticated npm session):
 
@@ -107,8 +132,9 @@ Manual publish (fallback, requires an authenticated npm session):
 npm run publish:manual
 ```
 
-Pre-releases: `npm version prerelease --preid=beta`, then `npm publish ./dist/ds --tag next`.
+Pre-releases: `npm run release:beta` bumps to `x.y.z-beta.N`; the matching tag
+publishes under the `next` dist-tag (never `latest`).
 
 ## License
 
-UNLICENSED — proprietary to IDS Group Ltd.
+[MIT](LICENSE) © IDS Group Ltd