From 4e23db50ff35aa99a314b1c77f1c5b535c770464 Mon Sep 17 00:00:00 2001 From: LBU Date: Mon, 24 Aug 2026 09:31:58 +0200 Subject: [PATCH] FSHSP-159 docs(readme): add releasing a new version section --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 0b03db52..f55d9021 100644 --- a/README.md +++ b/README.md @@ -124,6 +124,26 @@ Details: [`.claude/rules/git-conventions.md`](.claude/rules/git-conventions.md) --- +## Releasing a new version + +Once all your changes are on `main` (⚠️ **never push directly to `main`**), here's how +to publish a new version of the `@4sh/ui-kit` and `@4sh/ui-kit-schematics` npm packages +(same version, same job). + +1. **Prepare the release, on `main`**: move `[Unreleased]` to a new + `[X.Y.Z] - YYYY-MM-DD` section in `CHANGELOG.md`, bump the version in + `projects/ui-kit/package.json`, commit. +2. **Publish**: _Actions → Publish @4sh/ui-kit to npm → Run workflow_ with + `dry_run: true` first, then `dry_run: false` — this waits for reviewer approval on + the `npm-publish` environment before actually publishing. +3. **Tag & release**: created **by the CI** after a successful publish — never tag or + release by hand. + +Full detail: [`docs/VERSIONING.md`](docs/VERSIONING.md) (when to bump what) · +[`docs/PUBLISHING.md`](docs/PUBLISHING.md) (full publish workflow, npm auth). + +--- + ## Going further | Topic | Where |