mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-06 22:40:14 -05:00

History

Kevin Ansfield 0f9449137f Fixed comment count in comments-ui when logged in as admin closes https://linear.app/ghost/issue/PLG-297 - we were setting the comment count Admin API browse comments response meta pagination data which will never be correct because it only counts top-level comments for pagination purposes - we have a public comment counts endpoint that is already fetched, there's no need to override that when using the Admin API because the overall count doesn't change across API's, even when the Admin API includes hidden comments because those don't impact the visible count - updated test setup so the title and count is shown so it can be asserted against - updated mocked api to correctly return count of all published comments+replies		2024-12-10 18:59:49 +00:00
..
src	Fixed comment count in comments-ui when logged in as admin	2024-12-10 18:59:49 +00:00
test	Fixed comment count in comments-ui when logged in as admin	2024-12-10 18:59:49 +00:00
.env
.eslintrc.js
.yarnrc
LICENSE
package.json	Bumped comments-ui to 0.24.1 (#21797 )	2024-12-04 02:48:20 +00:00
playwright.config.ts	Refactored comments-ui form management (#21621 )	2024-11-14 18:26:23 +00:00
postcss.config.cjs
README.md	Updated README of Comments UI with release instructions (#20560 )	2024-07-08 16:15:23 +00: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	Added Dev Container setup (#21279 )	2024-10-24 11:15:08 -07:00

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
(Optional) Clear JsDelivr cache to get the new version out instantly (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)

Minor / major release

Run yarn ship and select a minor or major version when prompted
Update the Comments UI version in ghost/core/core/shared/config/defaults.json to the new minor or major version (code)
Wait until a new version of Ghost is released