@tryghost/sodo-search 1.8.302 → 1.8.304

package/README.md

@@ -1,5 +1,7 @@
 # Sodo Search
 
+Search interface injected into Ghost sites.
+
 ## Development
 
 ### Pre-requisites
@@ -14,25 +16,27 @@ Start Ghost with the public-app watchers enabled:
 pnpm dev:public
 ```
 
-This starts the standard development environment and the Sodo Search watcher. To run only the package's build watcher, use `pnpm dev` from this directory.
-
-## Release
+This starts the standard development environment and the Sodo Search watcher.
+To work on this package by itself, run these commands from this directory:
 
-A patch release can be rolled out instantly in production, whereas a minor/major release requires the Ghost monorepo to be updated and released. 
-In either case, you need sufficient permissions to release `@tryghost` packages on NPM.
+```bash
+pnpm build    # one-off build
+pnpm dev      # watch and rebuild the UMD JavaScript and CSS
+pnpm test     # run unit tests once
+pnpm lint     # lint source and tests
+```
 
-### Patch release
+## Release
 
-1. Run `pnpm ship` and select a patch version when prompted
-2. Merge the release commit to `main`
+Patch releases are automatic. When Sodo Search changes on `main`, CI publishes the next patch version to npm and clears the jsDelivr cache. Sites using that major/minor line receive the patch without a Ghost release.
 
-### Minor / major release
+For an intentional minor or major release:
 
-1. Run `pnpm ship` and select a minor or major version when prompted
+1. From a clean branch, run `pnpm ship` and select a minor or major version
 2. Merge the release commit to `main`
-3. Wait until a new version of Ghost is released
+3. Wait for a public Ghost release to ship the new default version line
 
-To use the new version of Sodo-Search in Ghost, update the version in Ghost core's default configuration (currently at `core/shared/config/default.json`)
+`pnpm ship` updates both the package version and Ghost's default Sodo Search version.
 
 # Copyright & License 
 

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@tryghost/sodo-search",
   "type": "module",
-  "version": "1.8.302",
+  "version": "1.8.304",
+  "description": "Search interface for Ghost sites",
   "license": "MIT",
   "repository": {
     "type": "git",