@chordcommerce/analytics 1.21.0 → 1.21.1

package/README.md

@@ -162,6 +162,42 @@ Useage Example
 
 See [Chord’s documentation](https://docs.chord.co/api-reference) for a full API reference.
 
+## Releasing
+
+This package uses [semantic-release](https://github.com/semantic-release/semantic-release) to automate versioning and publishing. Releases are triggered automatically — no manual version bumps or publish steps are needed.
+
+### How it works
+
+1. Merge a PR into `main` (stable) or `beta` (pre-release).
+2. The **Test** GitHub Actions workflow runs.
+3. On success, the **Semantic Release** workflow runs automatically.
+4. `semantic-release` analyzes commit messages since the last release and determines the version bump.
+5. The package is published to npm and GitHub Packages, CHANGELOG.md is updated, and a Git tag is created.
+
+### Commit message conventions
+
+This repo enforces [Conventional Commits](https://www.conventionalcommits.org/) via commitlint. The commit message prefix determines the version bump:
+
+| Prefix                     | Version Bump          | Example                                                   |
+| -------------------------- | --------------------- | --------------------------------------------------------- |
+| `fix:`                     | Patch (1.0.0 → 1.0.1) | `fix: resolve race condition in consent adapter`          |
+| `feat:`                    | Minor (1.0.0 → 1.1.0) | `feat: add trackOrderCompleted method`                    |
+| `BREAKING CHANGE:` in body | Major (1.0.0 → 2.0.0) | Commit body contains `BREAKING CHANGE: remove legacy API` |
+
+Other prefixes (`chore:`, `ci:`, `docs:`, `refactor:`, `test:`, etc.) do **not** trigger a release.
+
+### Monorepo scoping
+
+This repo uses [semantic-release-monorepo](https://github.com/pmowrer/semantic-release-monorepo) to scope releases to individual packages. Only commits that touch files within a package's directory (e.g., `packages/core/`) are considered when determining the next version. Commits that only modify root-level files like `.github/workflows/`, `.nvmrc`, or other packages will not trigger a release for this package.
+
+### Pre-releases
+
+Merging to `beta` creates pre-release versions (e.g., `1.21.0-beta.1`). Use this for testing before promoting to `main`.
+
+### Dry run
+
+You can preview what a release would do without publishing by manually triggering the Semantic Release workflow in GitHub Actions with `dryRun` set to `true`.
+
 ## Support
 
 For support with setup and configuration, please contact Chord directly at **help@chord.co**.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@chordcommerce/analytics",
   "description": "Chord Commerce event tracking",
-  "version": "1.21.0",
+  "version": "1.21.1",
   "author": "Chord Commerce <help@chord.co> (https://www.chord.co)",
   "type": "module",
   "main": "dist/index.js",