mirror of https://github.com/TryGhost/Ghost.git synced 2025-02-17 23:44:39 -05:00

History

Fabien O'Carroll c4d60193f4 Updated release process for Search and Comments UI (#22146 ) ref https://github.com/TryGhost/Ghost/pull/22127 The update to the Portal release process has now been tested on main, it would be good to get Search & Comments updated to the same process so that it's easier to reason about releasing all of them.		2025-02-10 18:48:52 +07:00
..
src	✨ Updated Comments likes UI changes to be instant (#21861 )	2025-01-14 15:20:47 +09:00
test	✨ Updated Comments likes UI changes to be instant (#21861 )	2025-01-14 15:20:47 +09:00
.env
.eslintrc.js
.yarnrc
LICENSE	2025	2025-01-06 11:40:59 +00:00
package.json	Updated release process for Search and Comments UI (#22146 )	2025-02-10 18:48:52 +07:00
playwright.config.ts	Refactored comments-ui form management (#21621 )	2024-11-14 18:26:23 +00:00
postcss.config.cjs
README.md	Updated release process for Search and Comments UI (#22146 )	2025-02-10 18:48:52 +07:00
tailwind.config.js	Added highlight animation when scrolling to replied-to comment (#21781 )	2024-12-05 17:46:16 +00:00
tsconfig.json
tsconfig.node.json
vite.config.ts

README.md

Comments UI

Comments widget that is embedded at the bottom of posts in Ghost.

Development

Pre-requisites

Run yarn in Ghost monorepo root

Running via Ghost `yarn dev` in root folder

You can automatically start the comments dev server when developing Ghost by running Ghost (in root folder) via yarn dev --all or yarn dev --comments. This will host the comments JavaScript files, and makes sure that Ghost uses these locally hosted assets instead of the ones from the CDN.

Release

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.

Patch release

Run yarn ship and select a patch version when prompted
Merge the release commit to main

Minor / major release

Run yarn ship and select a minor or major version when prompted
Merge the release commit to main
Wait until a new version of Ghost is released

JsDelivr cache

If the CI doesn't clear JsDelivr cache to get the new version out instantly, you may want to do it yourself manually (docs). Typically, you'll need to open https://purge.jsdelivr.net/ghost/comments-ui@~${COMMENTS_UI_VERSION}/umd/comments-ui.min.js and 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)