Update CHANGELOG.md for v0.4.21-rc2 #831

hackerwins · 2024-05-29T11:24:42Z

What this PR does / why we need it?

Update CHANGELOG.md for v0.4.21-rc2

Any background context you want to provide?

What are the relevant tickets?

Fixes #

Checklist

Added relevant tests or not required
Didn't break anything

Summary by CodeRabbit

Bug Fixes
- Corrected an invalid error message in the application.
Chores
- Updated the version in package.json to "0.4.21-rc2".

coderabbitai · 2024-05-29T11:24:46Z

Walkthrough

The recent updates to the Yorkie JS SDK include fixing an invalid error message in the CRDTTreePos component and updating the version in package.json from "0.4.21-rc" to "0.4.21-rc2". These changes ensure better error handling and version management without altering the declarations of exported or public entities.

Changes

File	Change Summary
`CHANGELOG.md`	Fixed an invalid error message in `CRDTTreePos` by `@hackerwins`.
`package.json`	Updated the version from "0.4.21-rc" to "0.4.21-rc2".

Poem

In the land of code, a change was made,
Errors fixed, no more dismay,
Version numbers danced and swayed,
Yorkie’s path, a brighter day.
With CRDTTreePos now set right,
Bugs take flight, into the night.
🌟✨🐰

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov · 2024-05-29T11:28:21Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.46%. Comparing base (0b3ce28) to head (41f4d16).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #831   +/-   ##
=======================================
  Coverage   80.46%   80.46%           
=======================================
  Files          59       59           
  Lines        4535     4535           
  Branches      918      918           
=======================================
  Hits         3649     3649           
  Misses        619      619           
  Partials      267      267

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

coderabbitai

Actionable comments posted: 0

Outside diff range and nitpick comments (3)

CHANGELOG.md (3)
Line range hint 115-115: Consider using a hyphen in "Follow-up" to form the correct compound adjective as suggested by the static analysis tool.
- Follow up work after devtools mvp by @chacha912 in https://github.com/yorkie-team/yorkie-js-sdk/pull/734
+ Follow-up work after devtools mvp by @chacha912 in https://github.com/yorkie-team/yorkie-js-sdk/pull/734
Line range hint 123-123: Capitalize "Chrome" to refer to the software correctly.
- Implement devtools chrome extension by @chacha912 in https://github.com/yorkie-team/yorkie-js-sdk/pull/717
+ Implement devtools Chrome extension by @chacha912 in https://github.com/yorkie-team/yorkie-js-sdk/pull/717
Line range hint 181-181: Add a space between 'simultaneous-cursors' and 'by' to correct the formatting error.
- Add README and thumbnail on example 'simultaneous-cursors'by @banma1234 in https://github.com/yorkie-team/yorkie-js-sdk/pull/681
+ Add README and thumbnail on example 'simultaneous-cursors' by @banma1234 in https://github.com/yorkie-team/yorkie-js-sdk/pull/681

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0b3ce28 and 41f4d16.

Files selected for processing (2)

CHANGELOG.md (1 hunks)
package.json (1 hunks)

Files skipped from review due to trivial changes (1)

package.json

Additional Context Used

LanguageTool (5)

CHANGELOG.md (5)

Near line 115: ‘Follow up’ seems to be a compound adjective before a noun. Use a hyphen: “Follow-up”.
Context: ...am/yorkie-js-sdk/pull/735 ### Fixed - Follow up work after devtools mvp by @chacha912 i...
Rule ID: CA_FOLLOW_UP

Near line 123: The proper noun “Chrome” (= software from Google) needs to be capitalized.
Context: ...-01-19 ### Added - Implement devtools chrome extension by @chacha912 in https://gith...
Rule ID: GOOGLE_PRODUCTS

Near line 181: Unpaired symbol: ‘'’ seems to be missing
Context: ...1 - Add README and thumbnail on example 'simultaneous-cursors'by @banma1234 in ht...
Rule ID: EN_UNPAIRED_QUOTES

Near line 702: Possible missing article found.
Context: ...size of the array increases when moving element: #186 - Fix a bug that did not move aft...
Rule ID: AI_HYDRA_LEO_MISSING_AN

Near line 743: There seems to be a noun/verb agreement error. Did you mean “collects” or “collected”?
Context: ... - 2021-01-01 ### Added - Add garbage collect for Container type: #101 ### Changed ...
Rule ID: SINGULAR_NOUN_VERB_AGREEMENT

Markdownlint (168)

CHANGELOG.md (168)

12: null
Bare URL used

16: null
Bare URL used

17: null
Bare URL used

23: null
Bare URL used

27: null
Bare URL used

28: null
Bare URL used

29: null
Bare URL used

33: null
Bare URL used

34: null
Bare URL used

40: null
Bare URL used

44: null
Bare URL used

45: null
Bare URL used

46: null
Bare URL used

47: null
Bare URL used

48: null
Bare URL used

49: null
Bare URL used

50: null
Bare URL used

54: null
Bare URL used

55: null
Bare URL used

56: null
Bare URL used

57: null
Bare URL used

58: null
Bare URL used

59: null
Bare URL used

60: null
Bare URL used

66: null
Bare URL used

72: null
Bare URL used

76: null
Bare URL used

77: null
Bare URL used

78: null
Bare URL used

79: null
Bare URL used

80: null
Bare URL used

86: null
Bare URL used

92: null
Bare URL used

96: null
Bare URL used

100: null
Bare URL used

101: null
Bare URL used

102: null
Bare URL used

103: null
Bare URL used

104: null
Bare URL used

110: null
Bare URL used

111: null
Bare URL used

115: null
Bare URL used

116: null
Bare URL used

117: null
Bare URL used

123: null
Bare URL used

127: null
Bare URL used

128: null
Bare URL used

129: null
Bare URL used

130: null
Bare URL used

134: null
Bare URL used

135: null
Bare URL used

141: null
Bare URL used

145: null
Bare URL used

146: null
Bare URL used

147: null
Bare URL used

148: null
Bare URL used

154: null
Bare URL used

155: null
Bare URL used

156: null
Bare URL used

160: null
Bare URL used

166: null
Bare URL used

167: null
Bare URL used

168: null
Bare URL used

172: null
Bare URL used

173: null
Bare URL used

174: null
Bare URL used

180: null
Bare URL used

181: null
Bare URL used

182: null
Bare URL used

186: null
Bare URL used

187: null
Bare URL used

191: null
Bare URL used

192: null
Bare URL used

198: null
Bare URL used

199: null
Bare URL used

200: null
Bare URL used

201: null
Bare URL used

202: null
Bare URL used

203: null
Bare URL used

204: null
Bare URL used

208: null
Bare URL used

212: null
Bare URL used

213: null
Bare URL used

214: null
Bare URL used

215: null
Bare URL used

221: null
Bare URL used

222: null
Bare URL used

223: null
Bare URL used

224: null
Bare URL used

225: null
Bare URL used

226: null
Bare URL used

227: null
Bare URL used

231: null
Bare URL used

232: null
Bare URL used

233: null
Bare URL used

234: null
Bare URL used

238: null
Bare URL used

239: null
Bare URL used

243: null
Bare URL used

244: null
Bare URL used

245: null
Bare URL used

251: null
Bare URL used

252: null
Bare URL used

253: null
Bare URL used

254: null
Bare URL used

255: null
Bare URL used

256: null
Bare URL used

257: null
Bare URL used

261: null
Bare URL used

262: null
Bare URL used

263: null
Bare URL used

264: null
Bare URL used

265: null
Bare URL used

266: null
Bare URL used

267: null
Bare URL used

273: null
Bare URL used

274: null
Bare URL used

275: null
Bare URL used

276: null
Bare URL used

277: null
Bare URL used

278: null
Bare URL used

284: null
Bare URL used

285: null
Bare URL used

289: null
Bare URL used

290: null
Bare URL used

291: null
Bare URL used

292: null
Bare URL used

296: null
Bare URL used

297: null
Bare URL used

301: null
Bare URL used

302: null
Bare URL used

303: null
Bare URL used

309: null
Bare URL used

310: null
Bare URL used

316: null
Bare URL used

320: null
Bare URL used

324: null
Bare URL used

330: null
Bare URL used

331: null
Bare URL used

332: null
Bare URL used

338: null
Bare URL used

339: null
Bare URL used

340: null
Bare URL used

341: null
Bare URL used

347: null
Bare URL used

351: null
Bare URL used

352: null
Bare URL used

358: null
Bare URL used

359: null
Bare URL used

363: null
Bare URL used

364: null
Bare URL used

389: null
Bare URL used

390: null
Bare URL used

391: null
Bare URL used

395: null
Bare URL used

396: null
Bare URL used

404: null
Bare URL used

410: null
Bare URL used

414: null
Bare URL used

415: null
Bare URL used

416: null
Bare URL used

417: null
Bare URL used

421: null
Bare URL used

427: null
Bare URL used

428: null
Bare URL used

429: null
Bare URL used

430: null
Bare URL used

434: null
Bare URL used

Additional comments not posted (1)

CHANGELOG.md (1)

17-17: The entry for fixing an invalid error message in CRDTTreePos is correctly documented under the "Fixed" section for the upcoming release. This aligns with the PR's objective and the AI-generated summary.

Update CHANGELOG.md for v0.4.21-rc2

41f4d16

hackerwins force-pushed the v0.4.21-rc2 branch from 0b41f34 to 41f4d16 Compare May 29, 2024 11:25

hackerwins marked this pull request as ready for review May 29, 2024 11:25

coderabbitai bot reviewed May 29, 2024

View reviewed changes

hackerwins merged commit 1c02b57 into main May 29, 2024
2 checks passed

hackerwins deleted the v0.4.21-rc2 branch May 29, 2024 11:28

hackerwins added a commit that referenced this pull request May 29, 2024

Update CHANGELOG.md for v0.4.21-rc2 (#831)

c5e7e3a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update CHANGELOG.md for v0.4.21-rc2 #831

Update CHANGELOG.md for v0.4.21-rc2 #831

hackerwins commented May 29, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 29, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

codecov bot commented May 29, 2024

coderabbitai bot left a comment

Update CHANGELOG.md for v0.4.21-rc2 #831

Update CHANGELOG.md for v0.4.21-rc2 #831

Conversation

hackerwins commented May 29, 2024 • edited by coderabbitai bot Loading

What this PR does / why we need it?

Any background context you want to provide?

What are the relevant tickets?

Checklist

Summary by CodeRabbit

coderabbitai bot commented May 29, 2024 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

codecov bot commented May 29, 2024

Codecov Report

coderabbitai bot left a comment

Choose a reason for hiding this comment

hackerwins commented May 29, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 29, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)