mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-27 22:49:56 -05:00

History

Kevin Ansfield 04f337e085 Fixed comments-ui tests not properly mocking actions on replies no issue - `MockedApi.browseComments` only worked on top-level comments, it couldn't find replies when passed `filter:'id:123'` such is used when liking and editing replies - fixed missing get handler for fetching single comment via Admin API (used after showing a hidden comment) - added `flattenComments` and `findCommentById` helper functions to facilitate easier finding of a comment or reply within the nested structure - added tests for liking and hiding replies		2024-11-26 18:34:02 +00:00
..
src	Fixed comments-ui tests not properly mocking actions on replies	2024-11-26 18:34:02 +00:00
test	Fixed comments-ui tests not properly mocking actions on replies	2024-11-26 18:34:02 +00:00
.env
.eslintrc.js
.yarnrc
LICENSE
package.json	Wired up admin api for hidden comments (#21724 )	2024-11-26 16:56:17 +08:00
playwright.config.ts	Refactored comments-ui form management (#21621 )	2024-11-14 18:26:23 +00:00
postcss.config.cjs
README.md
tailwind.config.js	Added Comments Sorting UI (#21375 )	2024-10-24 19:01:14 +09: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