-
Notifications
You must be signed in to change notification settings - Fork 23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Release 24.11.0 #8145
base: master
Are you sure you want to change the base?
Release 24.11.0 #8145
Conversation
WalkthroughThe pull request introduces updates for version 24.11.0 of WEBKNOSSOS, dated October 24, 2024. It includes new features such as metadata addition for annotations, improved time tracking, slider functionality, and enhanced search capabilities. Bug fixes address various issues, including dataset upload failures and annotation creation restrictions. The migration guide has been updated to include new Postgres evolution scripts, while the unreleased migration guide reflects a version number change and removes specific SQL entries. No breaking changes or alterations to public entity declarations were noted. Changes
Poem
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
CHANGELOG.released.md (1)
Line range hint
1-6000
: Consider adding a table of contentsFor better navigation in this large changelog file, consider adding a table of contents at the top that links to each version section.
# Changelog - [24.11.0](#24110---2024-10-24) - [24.10.0](#24100---2024-09-24) - [24.09.0](#24090---2024-08-29) ...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
- CHANGELOG.released.md (1 hunks)
- CHANGELOG.unreleased.md (1 hunks)
- MIGRATIONS.released.md (1 hunks)
- MIGRATIONS.unreleased.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
- MIGRATIONS.unreleased.md
🧰 Additional context used
🪛 Markdownlint
MIGRATIONS.released.md
12-12: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
🔇 Additional comments (7)
CHANGELOG.unreleased.md (2)
11-11
:⚠️ Potential issueUpdate the comparison URL for future changes.
Since this is the release of version 24.11.0, the comparison URL should be updated to start from this new version:
-[Commits](https://github.com/scalableminds/webknossos/compare/24.11.0...HEAD) +[Commits](https://github.com/scalableminds/webknossos/compare/24.10.0...HEAD)Likely invalid or redundant comment.
Line range hint
1-24
: Move all changes to CHANGELOG.released.md.Since this PR is releasing version 24.11.0, all the changes currently in the unreleased changelog should be moved to
CHANGELOG.released.md
. The unreleased changelog should only contain empty section headers for tracking future changes.MIGRATIONS.released.md (3)
9-10
: LGTM!The version header and release link follow the established format.
11-11
: LGTM!The commits comparison link follows the established format.
12-15
: LGTM! Verify the evolution scripts exist.The Postgres evolution scripts are correctly documented. Let's verify their existence in the repository.
✅ Verification successful
Evolution scripts and their reversions are present in the correct locations ✅
The verification confirms that both evolution scripts (
121-worker-name.sql
and122-resolution-to-mag.sql
) exist in the expectedconf/evolutions/
directory. Additionally, their corresponding reversion scripts are properly placed in theconf/evolutions/reversions/
directory, following the established pattern.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that the new evolution scripts exist in the repository. # Test: Check if the evolution scripts exist fd -t f "121-worker-name.sql|122-resolution-to-mag.sql" conf/evolutions/Length of output: 252
🧰 Tools
🪛 Markdownlint
12-12: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
CHANGELOG.released.md (2)
Line range hint
1-10
: LGTM: Well-structured changelog headerThe changelog follows best practices by:
- Clearly stating it's a released changelog
- Referencing the Keep a Changelog format
- Using Calendar Versioning
- Including migration guide reference
10-45
: LGTM: Latest version entry follows proper formatThe version 24.11.0 entry properly includes:
- Version number and release date
- Link to commits range
- Organized sections (Highlights, Added, Changed, Fixed)
- PR references
Summary by CodeRabbit
Release Notes for Version 24.11.0
New Features
Bug Fixes
Changes