Skip to content

Conversation

fm3
Copy link
Member

@fm3 fm3 commented Nov 13, 2024

We are skipping 24.11.0 to include a number of bugfixes.

Summary by CodeRabbit

Release Notes for Version 24.11.1

  • New Features

    • Added metadata support for annotations in Trees and Segments.
    • Introduced a summary row in the time tracking overview.
    • Improved slider functionality with mouse wheel support and reset options.
    • Enhanced search for unnamed segments using their full default names.
    • Added a button in the search popover to select all matching non-group results.
    • Increased loading speed for precomputed meshes.
    • Unified terminology in the UI, replacing "Resolution" with "Magnification."
    • Support for remote OME-Zarr NGFF version 0.5 datasets.
    • Superusers can now delete workflow reports.
  • Bug Fixes

    • Resolved dataset upload errors and scrolling issues in the trees and segments tab.
    • Fixed problems with the bbox export menu and sharing token handling during annotation saves.
    • Addressed layout persistence bugs leading to empty viewports.

@fm3 fm3 self-assigned this Nov 13, 2024
Copy link
Contributor

coderabbitai bot commented Nov 13, 2024

Walkthrough

The changes in this pull request include updates to the changelog and migration guides for version 24.11.1, released on November 13, 2024. New features introduced are the ability to add metadata to annotations for Trees and Segments, a summary row in the time tracking overview, and enhanced slider functionality. Additionally, several bug fixes and improvements have been made, including increased loading speeds for precomputed meshes and unified terminology in the UI. The migration guides have been updated to reflect these changes, including new Postgres evolution scripts.

Changes

File Change Summary
CHANGELOG.released.md Updated to include release notes for version 24.11.1; highlights new features and bug fixes.
CHANGELOG.unreleased.md Updated to reflect unreleased changes; modified versioning from 24.10.0 to 24.11.1.
MIGRATIONS.released.md Added release section for version 24.11.1 with links; introduced new Postgres evolution scripts.
MIGRATIONS.unreleased.md Updated versioning scheme; removed section listing Postgres evolutions and related SQL files.

Possibly related PRs

🐇 In the meadow where we play,
New features hop in bright array.
Metadata dances, sliders glide,
Bug fixes chase the woes aside.
With each release, we leap and cheer,
For WEBKNOSSOS, we hold dear! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9fbc67a and 991d029.

📒 Files selected for processing (1)
  • CHANGELOG.unreleased.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • CHANGELOG.unreleased.md

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.

Copy link
Contributor

@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: 1

🧹 Outside diff range and nitpick comments (1)
CHANGELOG.released.md (1)

24-24: Consider adding more context to the bug fix description

The bug fix description "Fixed that zarr streaming version 3 returned the shape of mag (1, 1, 1) / the finest mag for all mags" could benefit from additional context about the impact and resolution.

Consider expanding it to:

- Fixed a bug that zarr streaming version 3 returned the shape of mag (1, 1, 1) / the finest mag for all mags. [#8116]
+ Fixed a bug where zarr streaming version 3 incorrectly returned the shape of the finest magnification (1, 1, 1) for all magnification levels, which caused rendering issues. The correct magnification-specific shapes are now returned. [#8116]
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 015016b and 9fbc67a.

📒 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 (6)
CHANGELOG.unreleased.md (1)

Line range hint 13-23: LGTM! Changelog properly cleared for next release.

The changelog has been correctly cleared of all previous entries (which are now part of 24.11.1), while maintaining the standard sections for future unreleased changes. This follows changelog best practices.

MIGRATIONS.released.md (3)

9-10: LGTM: Release section header is properly formatted.

The new release section follows the established format and correctly documents version 24.11.1 with its release date.


11-11: LGTM: Commits link uses correct version range.

The link correctly compares version 24.10.0 to 24.11.1, which is consistent with skipping version 24.11.0.


12-16: Verify the existence and sequential order of evolution scripts.

The evolution scripts are properly listed and linked. Let's verify their existence and sequential ordering.

✅ Verification successful

Evolution scripts are correctly listed and ordered.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence and sequential order of the new evolution scripts.

# Test: Check if the evolution scripts exist and are in sequence
for script in 121-worker-name.sql 122-resolution-to-mag.sql 123-more-model-categories.sql; do
  if ! [ -f "conf/evolutions/$script" ]; then
    echo "Missing evolution script: $script"
  fi
done

# Test: Check if there are any gaps in the sequence
ls -1 conf/evolutions/*.sql | sort -n | awk -F'-' '{print $1}' | uniq -c | awk '$1>1{print "Duplicate sequence number: " $2}'

Length of output: 6096

🧰 Tools
🪛 Markdownlint

12-12: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

CHANGELOG.released.md (2)

Line range hint 1-9: LGTM: Well-structured changelog header

The header section follows best practices by clearly documenting:

  • The purpose of the file
  • Reference to unreleased changes
  • The versioning scheme used (CalVer)
  • Link to migration guide

10-54: LGTM: Latest release entry follows standard format

The latest release entry (24.11.1) follows good changelog practices:

  • Clear version number and release date
  • Link to compare changes with previous version
  • Changes organized into clear categories
  • Each change references relevant PR numbers


## Unreleased
[Commits](https://github.com/scalableminds/webknossos/compare/24.10.0...HEAD)
[Commits](https://github.com/scalableminds/webknossos/compare/24.11.1...HEAD)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Tag 24.11.1 Not Found

The specified tag "24.11.1" does not exist in the repository. Please ensure the tag is created before updating the comparison URL.

🔗 Analysis chain

LGTM! Version reference correctly updated.

The comparison URL has been properly updated to reference version 24.11.1, which aligns with the PR objective of releasing this version.

Let's verify the version reference:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the version tag exists and matches our changelog
# Expected: The tag should exist in the repository

git fetch --tags
git tag | grep "24.11.1" || echo "Tag 24.11.1 not found"

Length of output: 4866

@fm3 fm3 requested a review from normanrz November 13, 2024 10:52
@fm3 fm3 removed the request for review from MichaelBuessemeyer November 13, 2024 10:56
@fm3 fm3 merged commit eba9447 into master Nov 13, 2024
3 checks passed
@fm3 fm3 deleted the release-24.11.1 branch November 13, 2024 12:00
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.

2 participants