docs: update changelogs#1456
Conversation
0dc6f8a to
b9ab37e
Compare
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
WalkthroughMultiple CHANGELOGs were updated to version bumps and date changes. Airdrops: breaking API changes (SablierMerkleVCA.totalForgoneAmount() now returns 🚥 Pre-merge checks | ✅ 1 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
utils/CHANGELOG.md (1)
6-6:⚠️ Potential issue | 🟠 MajorVersion header should be major bump (
2.0.0) due to breaking changes.Line 6 still uses
1.1.0, but this release includes multiple breaking entries (Lines 10, 11, 16, 29). The changelog version should be bumped to a new major version.Suggested fix
-## [1.1.0] - 2026-03-16 +## [2.0.0] - 2026-03-16🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@utils/CHANGELOG.md` at line 6, Update the release header in the changelog from "## [1.1.0] - 2026-03-16" to the new major version "## [2.0.0] - 2026-03-16" to reflect the listed breaking changes; locate the header string "## [1.1.0] - 2026-03-16" in utils/CHANGELOG.md and replace it with "## [2.0.0] - 2026-03-16", and ensure any internal references to the released version within that section (the header text itself) match the new major version.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@bob/CHANGELOG.md`:
- Line 12: Replace the incorrect release link target for the Bob v1.0.0 entry by
updating the reference line that currently reads "[1.0.0]:
https://github.com/sablier-labs/evm-utils/releases/tag/v1.0.0" so it points to
the Bob package repository release for v1.0.0 (e.g. change the URL to the
correct GitHub releases tag for the Bob repo).
---
Duplicate comments:
In `@utils/CHANGELOG.md`:
- Line 6: Update the release header in the changelog from "## [1.1.0] -
2026-03-16" to the new major version "## [2.0.0] - 2026-03-16" to reflect the
listed breaking changes; locate the header string "## [1.1.0] - 2026-03-16" in
utils/CHANGELOG.md and replace it with "## [2.0.0] - 2026-03-16", and ensure any
internal references to the released version within that section (the header text
itself) match the new major version.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 6795941d-c7b5-47a5-b178-cb5ce3424cc4
📒 Files selected for processing (5)
airdrops/CHANGELOG.mdbob/CHANGELOG.mdflow/CHANGELOG.mdlockup/CHANGELOG.mdutils/CHANGELOG.md
andreivladbrg
left a comment
There was a problem hiding this comment.
thanks for the changes Shub, left some comments below and addressed some things in fbddbec
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
flow/CHANGELOG.md (1)
19-20: Consider verifying wording and explicit error mention.The entries are clear and properly formatted. However, note two minor points:
- The AI summary mentions "surplus zero check" while the changelog uses "zero surplus check" - verify which matches the actual code/PR.
- According to the AI summary,
SablierFlow_SurplusZeroerror was also removed in PR#1439. Consider adding an explicit line item for this removal to improve completeness, even if it's closely related to the surplus check removal.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@flow/CHANGELOG.md` around lines 19 - 20, Verify the phrasing against the actual PR/code: confirm whether the change removed a "zero surplus check" or a "surplus zero check" in the recover function and standardize the changelog wording to match the code; then add an explicit changelog line noting the removal of the SablierFlow_SurplusZero error (e.g., "Remove SablierFlow_SurplusZero error from recover function") so the entry clearly documents the error symbol removal alongside the Recover event and check removal.airdrops/CHANGELOG.md (1)
24-24: Minor formatting: Extra blank line.There's an extra blank line here that's inconsistent with the formatting before the "Removed" section (line 25). Consider removing it for consistency.
📝 Suggested formatting fix
- Add `sponsor` function to Merkle campaigns ([`#1443`](https://github.com/sablier-labs/lockup/pull/1443)) - ### Removed🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@airdrops/CHANGELOG.md` at line 24, Remove the extra blank line before the "Removed" section in CHANGELOG.md so formatting matches the sections above; locate the empty line immediately preceding the "Removed" heading and delete it to maintain consistent spacing and layout.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@lockup/CHANGELOG.md`:
- Line 17: Fix the typo in the changelog entry text "Add new `LPG`streams
model..." by inserting a space after the inline code closing backtick so it
reads "Add new `LPG` streams model..."; update the exact string in the
CHANGELOG.md entry to ensure the inline code token `LPG` is separated from
"streams" for proper formatting and readability.
---
Nitpick comments:
In `@airdrops/CHANGELOG.md`:
- Line 24: Remove the extra blank line before the "Removed" section in
CHANGELOG.md so formatting matches the sections above; locate the empty line
immediately preceding the "Removed" heading and delete it to maintain consistent
spacing and layout.
In `@flow/CHANGELOG.md`:
- Around line 19-20: Verify the phrasing against the actual PR/code: confirm
whether the change removed a "zero surplus check" or a "surplus zero check" in
the recover function and standardize the changelog wording to match the code;
then add an explicit changelog line noting the removal of the
SablierFlow_SurplusZero error (e.g., "Remove SablierFlow_SurplusZero error from
recover function") so the entry clearly documents the error symbol removal
alongside the Recover event and check removal.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e485fcd2-02db-43ac-a76a-46ba53365e23
📒 Files selected for processing (5)
airdrops/CHANGELOG.mdbob/CHANGELOG.mdflow/CHANGELOG.mdlockup/CHANGELOG.mdutils/CHANGELOG.md
🚧 Files skipped from review as they are similar to previous changes (1)
- bob/CHANGELOG.md
lockup/CHANGELOG.md
Outdated
| - Add Lockup Price Gated model with `createWithTimestampsLPG` and oracle-based token unlock ([#1406](https://github.com/sablier-labs/lockup/pull/1406)) | ||
| - Add zero-check validation for segment count and tranche count in `LockupHelpers` ([159ff1](https://github.com/sablier-labs/lockup/commit/159ff104)) | ||
| - **Breaking:** Add `granularity` parameter to LL model functions ([#1366](https://github.com/sablier-labs/lockup/pull/1366)) | ||
| - Add new `LPG`streams model that unlock tokens based on a target price of the stream token ([#1406](https://github.com/sablier-labs/lockup/pull/1406), [#1416](https://github.com/sablier-labs/lockup/pull/1416)) |
There was a problem hiding this comment.
Fix typo in LPG entry (LPGstreams → LPG streams).
There’s a missing space after the inline code token, which hurts readability.
✏️ Proposed fix
-- Add new `LPG`streams model that unlock tokens based on a target price of the stream token ([`#1406`](https://github.com/sablier-labs/lockup/pull/1406), [`#1416`](https://github.com/sablier-labs/lockup/pull/1416))
+- Add new `LPG` streams model that unlock tokens based on a target price of the stream token ([`#1406`](https://github.com/sablier-labs/lockup/pull/1406), [`#1416`](https://github.com/sablier-labs/lockup/pull/1416))📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Add new `LPG`streams model that unlock tokens based on a target price of the stream token ([#1406](https://github.com/sablier-labs/lockup/pull/1406), [#1416](https://github.com/sablier-labs/lockup/pull/1416)) | |
| - Add new `LPG` streams model that unlock tokens based on a target price of the stream token ([`#1406`](https://github.com/sablier-labs/lockup/pull/1406), [`#1416`](https://github.com/sablier-labs/lockup/pull/1416)) |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@lockup/CHANGELOG.md` at line 17, Fix the typo in the changelog entry text
"Add new `LPG`streams model..." by inserting a space after the inline code
closing backtick so it reads "Add new `LPG` streams model..."; update the exact
string in the CHANGELOG.md entry to ensure the inline code token `LPG` is
separated from "streams" for proper formatting and readability.
* chore: bump package versions docs: add new versions in CHANGELOG files * test: update version in test_ConstructCreate2Salt * docs: update changelogs (#1456) * docs: update changelogs * docs: update deprecate notice * docs: use today's date * docs: bump flow to a major version * docs: fix url in bob changelog * docs: polish changelogs * docs: update changelogs --------- Co-authored-by: Andrei Vlad Birgaoanu <andreivladbrg@gmail.com> --------- Co-authored-by: Shubham Yadav <shubhamy2015@gmail.com>
No description provided.