Skip to content
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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Release 24.11.0 #8145

wants to merge 1 commit into from

Conversation

fm3
Copy link
Member

@fm3 fm3 commented Oct 24, 2024

Summary by CodeRabbit

Release Notes for Version 24.11.0

  • New Features

    • Added metadata support for annotations on Trees and Segments.
    • Introduced a summary row in the time tracking overview.
    • Enhanced slider functionality for better user experience.
    • Improved search capabilities for unnamed segments.
    • Increased loading speeds for precomputed meshes.
    • Unified UI terminology to consistently use "Magnification."
  • Bug Fixes

    • Resolved issues with annotation creation for public datasets.
    • Fixed dataset upload problems with absolute paths.
    • Corrected behavior of zarr streaming version 3.
  • Changes

    • Disabling of certain actions in proofreading mode.
    • Admins can now view and cancel all jobs with ownership displayed.

@fm3 fm3 self-assigned this Oct 24, 2024
Copy link

coderabbitai bot commented Oct 24, 2024

Walkthrough

The 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

File Change Summary
CHANGELOG.released.md Updated with release notes for version 24.11.0; added new features, functionality changes, and bug fixes.
CHANGELOG.unreleased.md Updated to reflect unreleased changes; version updated from 24.10.0 to 24.11.0; new features and bug fixes documented.
MIGRATIONS.released.md Added section for version 24.11.0; included links to release and commits; added two new Postgres evolution scripts.
MIGRATIONS.unreleased.md Updated version reference from 24.10.0 to 24.11.0; removed Postgres evolutions section and related SQL file references.

Poem

In the meadow where changes bloom,
New features sprout, dispelling gloom.
With sliders that glide and searches that sing,
WEBKNOSSOS dances, oh what joy it brings!
Metadata whispers in trees and segments,
A hop, a skip, in joyful contentment! 🐇✨


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@fm3 fm3 requested a review from normanrz October 24, 2024 13:17
Copy link

@coderabbitai coderabbitai bot left a 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 contents

For 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

📥 Commits

Files that changed from the base of the PR and between 7b03f97 and ab5ee3f.

📒 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 issue

Update 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 and 122-resolution-to-mag.sql) exist in the expected conf/evolutions/ directory. Additionally, their corresponding reversion scripts are properly placed in the conf/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 header

The 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 format

The version 24.11.0 entry properly includes:

  • Version number and release date
  • Link to commits range
  • Organized sections (Highlights, Added, Changed, Fixed)
  • PR references

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant