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

History

Kevin Ansfield 52e727a28c Added in-reply-to references to comments-ui (#21656 ) ref https://linear.app/ghost/issue/PLG-230 When clicking "Reply" on a reply we now show an "In reply to" reference on the form and when saved show that reference in the rendered view, making it easier to follow discussions within comment replies. - updated calls to `openCommentForm` action when opening a reply to add the in-reply-to data to the `openForm` instance - updated Form comment to use the `openForm` instance data when rendering the in-reply-to reference - updated Comment component to render the in-reply-to reference from the API-provided data - includes click handler to scroll to the referenced comment - added `getCommentInReplyToSnippet` helper function so strip a comment back to plaintext for display in the reply-to reference on the comment form (snippets on other comments are generated server-side) --------- Co-authored-by: Sanne de Vries <sannedv@protonmail.com>		2024-11-19 17:30:18 +00:00
..
src	Added in-reply-to references to comments-ui (#21656 )	2024-11-19 17:30:18 +00:00
test	Added in-reply-to references to comments-ui (#21656 )	2024-11-19 17:30:18 +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	Migrated from Webpack to Vite and updated dependencies	2023-06-21 15:28:01 +02:00
package.json	Added in-reply-to references to comments-ui (#21656 )	2024-11-19 17:30:18 +00:00
playwright.config.ts	Refactored comments-ui form management (#21621 )	2024-11-14 18:26:23 +00: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