@tryghost/comments-ui 1.6.37 → 1.6.39

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +15 -13
  2. package/package.json +2 -1
package/README.md CHANGED
@@ -16,26 +16,28 @@ Start Ghost with the public-app watchers enabled:
16
16
  pnpm dev:public
17
17
  ```
18
18
 
19
- This starts the standard development environment and the Comments UI watcher. To run only the package's build watcher, use `pnpm dev` from this directory.
19
+ This starts the standard development environment and the Comments UI watcher.
20
+ To work on this package by itself, run these commands from this directory:
20
21
 
21
- ## Release
22
-
23
- 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.
22
+ ```bash
23
+ pnpm build # one-off build
24
+ pnpm dev # watch and rebuild the UMD bundle
25
+ pnpm test # run type checks and unit tests
26
+ pnpm test:acceptance # run browser acceptance tests
27
+ pnpm lint # lint code and check types
28
+ ```
24
29
 
25
- ### Patch release
30
+ ## Release
26
31
 
27
- 1. Run `pnpm ship` and select a patch version when prompted
28
- 2. Merge the release commit to `main`
32
+ Patch releases are automatic. When Comments 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.
29
33
 
30
- ### Minor / major release
34
+ For an intentional minor or major release:
31
35
 
32
- 1. Run `pnpm ship` and select a minor or major version when prompted
36
+ 1. From a clean branch, run `pnpm ship` and select a minor or major version
33
37
  2. Merge the release commit to `main`
34
- 3. Wait until a new version of Ghost is released
38
+ 3. Wait for a public Ghost release to ship the new default version line
35
39
 
36
- ### JsDelivr cache
37
- If the CI doesn't clear JsDelivr cache to get the new version out instantly, you may want to do it yourself manually ([docs](https://www.notion.so/ghost/How-to-clear-jsDelivr-CDN-cache-2930bdbac02946eca07ac23ab3199bfa?pvs=4)). Typically, you'll need to open `https://purge.jsdelivr.net/ghost/comments-ui@~${COMMENTS_UI_VERSION}/umd/comments-ui.min.js` and
38
- `https://purge.jsdelivr.net/ghost/comments-ui@~${COMMENTS_UI_VERSION}/umd/main.css` in your browser, where `COMMENTS_UI_VERSION` is the latest minor version in `ghost/core/core/shared/config/defaults.json` ([code](https://github.com/TryGhost/Ghost/blob/0aef3d3beeebcd79a4bfd3ad27e0ac67554b5744/ghost/core/core/shared/config/defaults.json#L198))
40
+ `pnpm ship` updates both the package version and Ghost's default Comments version.
39
41
 
40
42
  # Copyright & License
41
43
 
package/package.json CHANGED
@@ -1,7 +1,8 @@
1
1
  {
2
2
  "name": "@tryghost/comments-ui",
3
3
  "type": "module",
4
- "version": "1.6.37",
4
+ "version": "1.6.39",
5
+ "description": "Comments interface for Ghost posts",
5
6
  "license": "MIT",
6
7
  "repository": {
7
8
  "type": "git",