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

History

Kevin Ansfield 962939b99a Shipped comments-ui@1.0.2 no issue - contains two minor bug fixes for edit name/expertise buttons on the main form and incorrect replies-left-to-load counts after deleting replies		2024-12-12 19:03:23 +00:00
..
src	Fixed incorrect replies pagination count after deleting reply	2024-12-12 19:03:23 +00:00
test	Fixed incorrect replies pagination count after deleting reply	2024-12-12 19:03:23 +00:00
.env
.eslintrc.js	✨Extended translations beta to comments (#17801 )	2023-08-24 10:33:03 +02:00
.yarnrc	Prevented git tags from being created for apps	2023-07-10 13:09:28 +02:00
LICENSE
package.json	Shipped comments-ui@1.0.2	2024-12-12 19:03:23 +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	Converted Comments-UI App to TypeScript and React hooks (#17760 )	2023-08-18 13:30:59 +00:00
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