mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-20 22:42:53 -05:00

History

Kevin Ansfield a996cde39d Fixed flaky member expertise test no issue - a change in browser version/dependency versions/playwright/something else has made this test flaky because the reply editor form loses focus when the expertise field gains focus (this doesn't happen in the browser) meaning when we get to our assertions the elements we care about are missing - forcing focus back puts us into a known state for our assertions		2024-09-25 15:25:34 +01:00
..
src	Updated comment report modal (#21084 )	2024-09-24 11:13:22 +02:00
test	Fixed flaky member expertise test	2024-09-25 15:25:34 +01: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	Migrated from Webpack to Vite and updated dependencies	2023-06-21 15:28:01 +02:00
package.json	Update tiptap monorepo to v2.7.2	2024-09-25 12:13:09 +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	Improved comments UI styles (#20957 )	2024-09-18 12:52:13 +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	Migrated Comments-UI to TypeScript (#17129 )	2023-06-27 14:51:37 +02:00
vite.config.ts	Hidden "info" Vite output unless in CI	2023-11-15 10:11:22 +01: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