mirror of https://github.com/TryGhost/Ghost.git synced 2024-11-25 09:03:12 +03:00

History

Kevin Ansfield 2474abca9d Fixed flaky avatar saturation test in comments-ui no issue - running tests locally, especially in UI mode, would often result in an avatar saturation test failing - the cause was calculating saturation for an element that still had it's opacity animating in - added a test util function that waits for an element in a frame to reach full opacity - used function in test to ensure we have a stable element before calculating the color saturation		2024-11-13 12:09:45 -06:00
..
src	Fixed flaky avatar saturation test in comments-ui	2024-11-13 12:09:45 -06:00
test	Fixed flaky avatar saturation test in comments-ui	2024-11-13 12:09:45 -06:00
.env	Added custom build setup	2022-07-04 15:15:01 +02:00
.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	Migrated from Webpack to Vite and updated dependencies	2023-06-21 15:28:01 +02:00
package.json	Bumped Comments-UI to 0.21.8	2024-11-05 10:55:50 +00:00
playwright.config.ts	Temporarily increased timeout for Comments-UI web server init	2023-09-15 10:48:08 +02:00
postcss.config.cjs	Migrated Comments-UI to TypeScript (#17129 )	2023-06-27 14:51:37 +02:00
README.md	Updated README of Comments UI with release instructions (#20560 )	2024-07-08 16:15:23 +00:00
tailwind.config.js	Added Comments Sorting UI (#21375 )	2024-10-24 19:01:14 +09:00
tsconfig.json	Converted Comments-UI App to TypeScript and React hooks (#17760 )	2023-08-18 13:30:59 +00:00
tsconfig.node.json	Migrated Comments-UI to TypeScript (#17129 )	2023-06-27 14:51:37 +02:00
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