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

History

Kevin Ansfield 65d84fad17 Refactored cta/main form conditional in comments-ui no issue - micro-refactor that came out of a bigger draft-replies refactor, splitting out early to keep main change cleaner - adjusted nested ternary style and naming to improve clarity - added unit tests to ensure the logic behaviour stayed consistent - cleaned up useless dummy unit test file		2024-10-15 12:50:12 +01:00
..
src	Refactored cta/main form conditional in comments-ui	2024-10-15 12:50:12 +01:00
test	Refactored cta/main form conditional in comments-ui	2024-10-15 12:50:12 +01:00
.env
.eslintrc.js	✨Extended translations beta to comments (#17801 )	2023-08-24 10:33:03 +02:00
.yarnrc
LICENSE
package.json	Bumped comments-ui (#21217 )	2024-10-03 21:40:00 +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
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
tsconfig.node.json
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