Update CHANGELOG.md for v0.4.20 #820
Conversation
|
Warning Rate Limit Exceeded@hackerwins has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 37 minutes and 30 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. WalkthroughIn version Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (3)
CHANGELOG.md (3)
Line range hint
164-164: Correct the missing apostrophe in the entry about the 'simultaneous-cursors' example.- Add README and thumbnail on example 'simultaneous-cursors'by @banma1234 in https://github.com/yorkie-team/yorkie-js-sdk/pull/819 + Add README and thumbnail on example 'simultaneous-cursors' by @banma1234 in https://github.com/yorkie-team/yorkie-js-sdk/pull/819
Line range hint
106-106: Capitalize "Chrome" in the entry about the devtools chrome extension.- 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
98-98: Add a hyphen to "Follow up" to form the compound adjective "Follow-up".- 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
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
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 (4)
CHANGELOG.md (4)
Near line 98: ‘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...
Near line 106: The proper noun “Chrome” (= software from Google) needs to be capitalized.
Context: ...-01-19 ### Added - Implement devtools chrome extension by @chacha912 in https://gith...
Near line 164: Unpaired symbol: ‘'’ seems to be missing
Context: ...1 - Add README and thumbnail on example 'simultaneous-cursors'by @banma1234 in ht...
Near line 726: 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 ...
Markdownlint (165)
CHANGELOG.md (165)
12: null
Bare URL used
13: null
Bare URL used
14: null
Bare URL used
15: 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
30: null
Bare URL used
31: null
Bare URL used
32: null
Bare URL used
33: null
Bare URL used
37: null
Bare URL used
38: null
Bare URL used
39: null
Bare URL used
40: null
Bare URL used
41: null
Bare URL used
42: null
Bare URL used
43: null
Bare URL used
49: null
Bare URL used
55: null
Bare URL used
59: null
Bare URL used
60: null
Bare URL used
61: null
Bare URL used
62: null
Bare URL used
63: null
Bare URL used
69: null
Bare URL used
75: null
Bare URL used
79: null
Bare URL used
83: null
Bare URL used
84: null
Bare URL used
85: null
Bare URL used
86: null
Bare URL used
87: null
Bare URL used
93: null
Bare URL used
94: null
Bare URL used
98: null
Bare URL used
99: null
Bare URL used
100: null
Bare URL used
106: null
Bare URL used
110: null
Bare URL used
111: null
Bare URL used
112: null
Bare URL used
113: null
Bare URL used
117: null
Bare URL used
118: null
Bare URL used
124: null
Bare URL used
128: null
Bare URL used
129: null
Bare URL used
130: null
Bare URL used
131: null
Bare URL used
137: null
Bare URL used
138: null
Bare URL used
139: null
Bare URL used
143: null
Bare URL used
149: null
Bare URL used
150: null
Bare URL used
151: null
Bare URL used
155: null
Bare URL used
156: null
Bare URL used
157: null
Bare URL used
163: null
Bare URL used
164: null
Bare URL used
165: null
Bare URL used
169: null
Bare URL used
170: null
Bare URL used
174: null
Bare URL used
175: null
Bare URL used
181: null
Bare URL used
182: null
Bare URL used
183: null
Bare URL used
184: null
Bare URL used
185: null
Bare URL used
186: null
Bare URL used
187: null
Bare URL used
191: null
Bare URL used
195: null
Bare URL used
196: null
Bare URL used
197: null
Bare URL used
198: null
Bare URL used
204: null
Bare URL used
205: null
Bare URL used
206: null
Bare URL used
207: null
Bare URL used
208: null
Bare URL used
209: null
Bare URL used
210: null
Bare URL used
214: null
Bare URL used
215: null
Bare URL used
216: null
Bare URL used
217: null
Bare URL used
221: null
Bare URL used
222: null
Bare URL used
226: null
Bare URL used
227: null
Bare URL used
228: null
Bare URL used
234: null
Bare URL used
235: null
Bare URL used
236: null
Bare URL used
237: null
Bare URL used
238: null
Bare URL used
239: null
Bare URL used
240: null
Bare URL used
244: null
Bare URL used
245: null
Bare URL used
246: null
Bare URL used
247: null
Bare URL used
248: null
Bare URL used
249: null
Bare URL used
250: null
Bare URL used
256: null
Bare URL used
257: null
Bare URL used
258: null
Bare URL used
259: null
Bare URL used
260: null
Bare URL used
261: null
Bare URL used
267: null
Bare URL used
268: null
Bare URL used
272: null
Bare URL used
273: null
Bare URL used
274: null
Bare URL used
275: null
Bare URL used
279: null
Bare URL used
280: null
Bare URL used
284: null
Bare URL used
285: null
Bare URL used
286: null
Bare URL used
292: null
Bare URL used
293: null
Bare URL used
299: null
Bare URL used
303: null
Bare URL used
307: null
Bare URL used
313: null
Bare URL used
314: null
Bare URL used
315: null
Bare URL used
321: null
Bare URL used
322: null
Bare URL used
323: null
Bare URL used
324: null
Bare URL used
330: null
Bare URL used
334: null
Bare URL used
335: null
Bare URL used
341: null
Bare URL used
342: null
Bare URL used
346: null
Bare URL used
347: null
Bare URL used
372: null
Bare URL used
373: null
Bare URL used
374: null
Bare URL used
378: null
Bare URL used
379: null
Bare URL used
387: null
Bare URL used
393: null
Bare URL used
397: null
Bare URL used
398: null
Bare URL used
399: null
Bare URL used
400: null
Bare URL used
404: null
Bare URL used
410: null
Bare URL used
411: null
Bare URL used
412: null
Bare URL used
413: null
Bare URL used
417: null
Bare URL used
Additional comments not posted (1)
CHANGELOG.md (1)
10-18: Ensure all entries under version 0.4.20 accurately reflect the changes made in the corresponding pull requests.Verification successful
The entries in the CHANGELOG.md for version 0.4.20 have been verified against the corresponding pull requests, and they accurately reflect the changes made. Here are the details:
- Handle Tree.toXML to return proper XML string: Verified with PR Handle Tree.toXML to return proper XML string #805.
- Update examples version to v0.4.19: Verified with PR Update examples version to v0.4.19 #812.
- Enhance type inference in Document.subscribe: Verified with PR Enhance type inference in Document.subscribe #814.
- Implement RHT.GC: Verified with PR Implement RHT.GC #815.
- Apply GCPair to TreeNode, TextNode: Verified with PR Apply GCPair to TreeNode, TextNode #819.
No discrepancies were found between the CHANGELOG entries and the pull request details.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accuracy of the entries in CHANGELOG.md for version 0.4.20 by checking the corresponding pull requests. # Check the pull requests mentioned in the entries for version 0.4.20 cat CHANGELOG.md | grep -A 8 "## \[0.4.20\]" | grep -oP 'https://github.com/yorkie-team/yorkie-js-sdk/pull/\d+' | xargs -n 1 curl -s | jq '.title, .body'Length of output: 155
Script:
#!/bin/bash # Description: Verify the accuracy of the entries in CHANGELOG.md for version 0.4.20 by checking the corresponding pull requests. # Extract the URLs of the pull requests mentioned in the entries for version 0.4.20 urls=$(cat CHANGELOG.md | grep -A 8 "## \[0.4.20\]" | grep -oP 'https://github.com/yorkie-team/yorkie-js-sdk/pull/\d+') # Fetch the details of these pull requests and output the title and body for verification for url in $urls; do echo "Fetching details for $url" curl -s $url | jq '.title, .body' doneLength of output: 2000
Script:
#!/bin/bash # Description: Verify the accuracy of the entries in CHANGELOG.md for version 0.4.20 by checking the corresponding pull requests using the GitHub API. # Extract the pull request numbers from the URLs mentioned in the entries for version 0.4.20 pr_numbers=$(cat CHANGELOG.md | grep -A 8 "## \[0.4.20\]" | grep -oP 'https://github.com/yorkie-team/yorkie-js-sdk/pull/\d+' | grep -oP '\d+') # Fetch the details of these pull requests using the GitHub API and output the title and body for verification for pr_number in $pr_numbers; do echo "Fetching details for pull request #$pr_number" curl -s "https://api.github.com/repos/yorkie-team/yorkie-js-sdk/pulls/$pr_number" | jq '.title, .body' doneLength of output: 5906
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #820 +/- ##
==========================================
- Coverage 80.48% 80.41% -0.07%
==========================================
Files 59 59
Lines 4535 4535
Branches 918 918
==========================================
- Hits 3650 3647 -3
- Misses 617 620 +3
Partials 268 268 ☔ View full report in Codecov by Sentry. |
What this PR does / why we need it?
Update CHANGELOG.md for v0.4.20
Any background context you want to provide?
What are the relevant tickets?
Fixes #
Checklist
Summary by CodeRabbit
New Features
Tree.toXMLto return valid XML.Document.subscribe.RHT.GCfor better garbage collection.GCPairforTreeNodeandTextNode.Optimizations
Documentation
v0.4.19.Chores
0.4.20.