@doist/react-interpolate 2.2.1 → 2.2.3

package/README.md

@@ -215,14 +215,15 @@ import { SYNTAX_I18NEXT } from "react-interpolate"
 
 # Releasing
 
-A new version of @doist/react-interpolate is published both on npm and GitHub Package Registry whenever a new release on GitHub is created.
+Releases are fully automated with [semantic-release](https://semantic-release.gitbook.io/). There is no manual version bump: the next version number, the changelog, the git tag, the GitHub release, and the npm/GitHub Package Registry publishes are all derived from the commit history.
 
-To update the version in both `package.json` and `package-lock.json` run:
+Every push to `main` runs the `Release` workflow, which:
 
-```sh
-npm --no-git-tag-version version <major|minor|patch>
-```
+1. analyses the [Conventional Commits](https://www.conventionalcommits.org/) since the last release to determine the next version (`fix:` → patch, `feat:` → minor, `feat!:`/`BREAKING CHANGE` → major),
+2. updates `CHANGELOG.md`, `package.json`, and `package-lock.json` and commits them back,
+3. tags the release and publishes the GitHub release notes, and
+4. publishes the package to npm with provenance.
 
-Once these changes have been pushed and merged, create a release on GitHub.
+Because the version is inferred from commits, **pull request titles and commits must follow the Conventional Commits format** — this is enforced by the `Semantic Pull Request` check. If a batch of commits contains no releasable changes (e.g. only `chore:`/`docs:`/`ci:`), no release is published.
 
-A GitHub Action will automatically perform all the necessary steps and will release the version number that's specified inside the `package.json`'s `version` field so make sure that the release tag reflects the version you want to publish.
+Pushes to the `next` branch publish a prerelease on the `next` dist-tag without updating the changelog.

package/package.json

@@ -1,13 +1,18 @@
 {
     "name": "@doist/react-interpolate",
-    "version": "2.2.1",
+    "version": "2.2.3",
+    "repository": "https://github.com/Doist/react-interpolate",
     "license": "MIT",
     "description": "A string interpolation component that formats and interpolates a template string in a safe way",
     "main": "dist/react-interpolate.cjs",
     "module": "dist/react-interpolate.mjs",
     "types": "dist/react-interpolate.d.ts",
+    "publishConfig": {
+        "access": "public",
+        "provenance": true
+    },
     "engines": {
-        "node": "^20.0.0 || ^21.0.0 || ^22.0.0",
+        "node": "^20.0.0 || ^22.0.0 || ^24.0.0 || ^26.0.0",
         "npm": "^10.0.0 || ^11.0.0"
     },
     "files": [
@@ -20,13 +25,10 @@
         "build": "del dist && rollup -c && npm run mini-cjs && npm run mini-mjs",
         "mini-cjs": "uglifyjs dist/react-interpolate.cjs --compress --mangle --enclose --output  dist/react-interpolate.min.cjs",
         "mini-mjs": "uglifyjs dist/react-interpolate.mjs --compress --mangle --enclose --output dist/react-interpolate.min.mjs",
-        "prettify": "prettier --write ."
+        "prettify": "prettier --write .",
+        "prepublishOnly": "npm run build && npm run test"
     },
     "prettier": "@doist/prettier-config",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/Doist/react-interpolate.git"
-    },
     "keywords": [
         "react",
         "interpolate",
@@ -50,8 +52,11 @@
         "@babel/runtime": "7.18.6",
         "@doist/eslint-config": "7.1.2",
         "@doist/prettier-config": "3.0.5",
+        "@semantic-release/changelog": "6.0.3",
+        "@semantic-release/git": "10.0.1",
         "@testing-library/react": "13.3.0",
         "babel-jest": "28.1.2",
+        "conventional-changelog-conventionalcommits": "9.3.1",
         "core-js": "3.23.3",
         "del-cli": "4.0.1",
         "eslint": "8.18.0",
@@ -71,6 +76,7 @@
         "rollup": "2.75.7",
         "rollup-plugin-babel": "4.4.0",
         "rollup-plugin-copy": "3.5.0",
+        "semantic-release": "25.0.5",
         "uglify-es": "3.3.9"
     }
 }