Create Release 25.02.0 #8398
Create Release 25.02.0 #8398
Conversation
fm3
commented
Feb 17, 2025
fm3
commented
- Updated changelog
- Updated migration guide if applicable
📝 WalkthroughWalkthroughThe update releases WEBKNOSSOS version 25.02.0 with extensive enhancements and fixes. Changes include a consolidation of annotation histories into a single, revertible linear timeline and simultaneous layer reversion. New features have been added for neuron inference and dataset handling, while the UI now requires focused slider scrolling and prevents unwanted parent scrolling. In addition, updates in migration guides document configuration option renaming and revised FossilDB migration instructions, along with removal of deprecated features. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
⏰ Context from checks skipped due to timeout of 90000ms (1)
🔇 Additional comments (1)
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 (
|
![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
🧹 Nitpick comments (3)
MIGRATIONS.released.md (1)
14-20: Detailed FossilDB Migration Instructions
This section provides a step‐by‐step guide for migrating FossilDB content, including:
• Using the Python tool attools/migration-unified-annotation-versioning
• Starting a second FossilDB using available options (docker image, jar, or repository checkout)
• Requiring the new FossilDB version0.1.34and specifying the new column family set
• Recommending incremental migration steps to avoid downtimeA couple of minor points to consider:
• Markdown Formatting: Several list items (especially in this block) show inconsistent indentation according to markdownlint (expected indent of 2 spaces). Adjusting the bullet indentations will improve readability and satisfy style guidelines.
• Repeated Phrasing: There is some repetitive language (e.g. the phrase “a second FossilDB needs to be started”). Consider introducing slight variation to enhance clarity.Otherwise, the instructions are comprehensive.
🧰 Tools
🪛 LanguageTool
[style] ~14-~14: Consider using a different adverb to strengthen your wording.
Context: ...r instructions). Note that it writes to a completely new FossilDB, that must first be opened...(COMPLETELY_ENTIRELY)
[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... - For the migration, a second FossilDB needs to be started. To do that, either use the ...(REP_NEED_TO_VB)
[style] ~15-~15: Consider a more expressive alternative.
Context: ...second FossilDB needs to be started. To do that, either use the docker image, a ja...(DO_ACHIEVE)
🪛 markdownlint-cli2 (0.17.2)
14-14: Unordered list indentation
Expected: 2; Actual: 5(MD007, ul-indent)
15-15: Inconsistent indentation for list items at the same level
Expected: 5; Actual: 4(MD005, list-indent)
15-15: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
16-16: Inconsistent indentation for list items at the same level
Expected: 5; Actual: 4(MD005, list-indent)
16-16: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
17-17: Inconsistent indentation for list items at the same level
Expected: 5; Actual: 4(MD005, list-indent)
17-17: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
18-18: Inconsistent indentation for list items at the same level
Expected: 5; Actual: 4(MD005, list-indent)
18-18: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
19-19: Inconsistent indentation for list items at the same level
Expected: 5; Actual: 4(MD005, list-indent)
19-19: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
CHANGELOG.released.md (2)
40-41: Empty breaking changes sectionThe "Breaking Changes" section is empty but present. Consider removing empty sections to keep the changelog concise.
-### Breaking Changes -
1-1121: Improve changelog formattingThe markdown linting tool indicates an indentation issue with unordered lists. The lists should be indented consistently.
- - Solution 1 (preferred): Replace the function with the numpy implementation. - - Solution 2: Refactor the function to use the in-built `sum` function. + - Solution 1 (preferred): Replace the function with the numpy implementation. + - Solution 2: Refactor the function to use the in-built `sum` function.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
38-38: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
CHANGELOG.released.md(1 hunks)CHANGELOG.unreleased.md(1 hunks)MIGRATIONS.released.md(2 hunks)MIGRATIONS.unreleased.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
MIGRATIONS.released.md
[style] ~14-~14: Consider using a different adverb to strengthen your wording.
Context: ...r instructions). Note that it writes to a completely new FossilDB, that must first be opened...
(COMPLETELY_ENTIRELY)
[style] ~15-~15: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... - For the migration, a second FossilDB needs to be started. To do that, either use the ...
(REP_NEED_TO_VB)
[style] ~15-~15: Consider a more expressive alternative.
Context: ...second FossilDB needs to be started. To do that, either use the docker image, a ja...
(DO_ACHIEVE)
🪛 markdownlint-cli2 (0.17.2)
MIGRATIONS.released.md
14-14: Unordered list indentation
Expected: 2; Actual: 5
(MD007, ul-indent)
15-15: Inconsistent indentation for list items at the same level
Expected: 5; Actual: 4
(MD005, list-indent)
15-15: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
16-16: Inconsistent indentation for list items at the same level
Expected: 5; Actual: 4
(MD005, list-indent)
16-16: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
17-17: Inconsistent indentation for list items at the same level
Expected: 5; Actual: 4
(MD005, list-indent)
17-17: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
18-18: Inconsistent indentation for list items at the same level
Expected: 5; Actual: 4
(MD005, list-indent)
18-18: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
19-19: Inconsistent indentation for list items at the same level
Expected: 5; Actual: 4
(MD005, list-indent)
19-19: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
21-21: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
CHANGELOG.released.md
38-38: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: circleci_build
🔇 Additional comments (9)
MIGRATIONS.unreleased.md (1)
9-9: Updated Commit Link for Unreleased Migrations
The new commit link (“Commits”) clearly references the changes since version 25.02.0. Please verify that this link correctly reflects the intended range of unreleased changes.CHANGELOG.unreleased.md (1)
11-11: Updated Commit Link in Unreleased Changelog
The commit link on line 11 (“Commits”) has been updated to reference the changes since v25.02.0. This is consistent with the other documentation; please ensure that the link remains current as new changes are made.MIGRATIONS.released.md (2)
9-10: New Release Header for Version 25.02.0
The release header now clearly shows version 25.02.0 along with the release date and a commit link comparing “25.01.0...25.02.0”. This update ensures that readers can easily identify the changes in this release. Please double-check that the compare link is correct and references the intended range.
11-13: Migration Configuration Updates
These lines document important changes:
• Renaming of the configuration options fromproxy.prefixandproxy.routestoaboutPageRedirect.prefixandaboutPageRedirect.routes.
• Removal of the migration routeaddSegmentIndex.
• Changes to the annotation versioning scheme requiring a larger FossilDB migration.The instructions are clear and well detailed. Ensure that all related documentation and migration scripts are updated accordingly.
CHANGELOG.released.md (5)
10-11: New version entry added correctlyThe new version 25.02.0 is properly added at the top of the changelog with the correct release date and link format.
13-15: Major changes highlighted appropriatelyThe highlights section effectively summarizes the key changes in this release, focusing on:
- Consolidation of annotation histories
- Revertible linear timeline
- Simultaneous layer reversion
17-24: Well-structured additions sectionThe "Added" section properly documents new features including:
- Split-merger evaluation during neuron inference
- Dataset rotation configuration
- Merger mode for volume data annotation
- Measurement tools accessibility
- Support for Blosc-compressed datasets
30-36: Fixed critical bugsImportant bug fixes for:
- Dashboard dataset list refresh
- Tree merging functionality
- Onboarding screen display
- Segment registration in coarser mags
- Flood fill tool in 2D mode
26-29:❓ Verification inconclusive
UI improvements need verification
The changes to slider scrolling behavior and parent scrolling prevention should be tested to ensure they don't negatively impact usability.
🌐 Web query:
Are there any known issues with slider scrolling behavior in web applications when preventing parent scrolling?💡 Result:
Several known issues can affect slider scrolling behavior when attempting to prevent parent scrolling in web applications, often related to CSS configurations, JavaScript interactions, or browser-specific quirks. Here are the key challenges and solutions:
Common Issues & Solutions
1. Scroll Chaining & Overscroll Effects
- Problem: Slider interactions (e.g., horizontal swipes) trigger unintended parent page scrolling ("scroll chaining")[2][4].
- Solution: Use
overscroll-behavior: containornoneon the slider container:This blocks scroll propagation to parent elements while retaining native bounce effects within the slider[2][4]..slider-container { overscroll-behavior: contain; /* Prevents scroll bleed */ }
2. CSS Overflow Conflicts
- Problem: Sliders using
overflow-x: hiddenorheight: 100%onhtml/bodyelements can break vertical scrolling or cause double scrollbars[1][3][9].- Fix:
- Avoid
height: 100%onhtml/bodyif using full-width sliders[1][9].- Disable conflicting
overflow-xsettings in slider configurations[1][3].- For mobile, apply
overflow-y: hidden !importantto sliders intercepting vertical touch events[3][5].
3. Touch Event Conflicts
- Problem: Mobile browsers may prioritize slider touch gestures over vertical page scrolling[3][5].
- Mitigation:
- Use
touch-action: pan-yon non-slider page elements to preserve vertical scroll[4].- For sliders requiring horizontal swipes:
.slider { touch-action: pan-x; }
4. JavaScript Interference
- Problem: Slider libraries often override default scroll behavior (e.g., auto-scrolling to the slider on interaction)[1][9].
- Adjustments:
- Disable "Scroll to slider" options in slider settings[1].
- Avoid
event.preventDefault()on slider touch events unless explicitly needed for horizontal swipes[3].
Platform-Specific Considerations
- Mobile Browsers: iOS Safari and Chrome for Android handle touch/scroll inertia differently; test
-webkit-overflow-scrollingfor smoother behavior[4][7].- Shopify/Dawn Theme: Sliders in CMS platforms may require CSS overrides (e.g.,
overflow-y: hidden) due to template constraints[3].- Third-Party Plugins: Outdated slider plugins (e.g., "Aitasi Coming Soon") can inject conflicting styles/scripts; update or replace them[9].
Debugging Tips
- Use browser DevTools to identify conflicting CSS rules (e.g.,
outline: 1px solid redon all elements)[4].- Test with
overscroll-behaviorandtouch-actionproperties first, as they resolve ~70% of cases[2][4].- Validate fixes across devices—trackpad vs. mouse vs. touchscreen behaviors vary significantly[8][10].
For persistent issues, prioritize lightweight libraries like Splide.js or Swiper.js with built-in scroll containment features[3][7].
Citations:
- 1: https://smartslider.helpscoutdocs.com/article/1951-scroll-problems
- 2: https://developer.mozilla.org/en-US/docs/Web/CSS/overscroll-behavior
- 3: https://community.shopify.com/c/shopify-design/collection-slider-issue-page-scrolling-bug-glitch-dawn-theme/m-p/2323890
- 4: https://blog.logrocket.com/how-to-prevent-overflow-scrolling-css/
- 5: https://forum.adalo.com/t/list-containing-image-slider-is-not-scrolling-down/5997
- 6: https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-behavior
- 7: https://height.app/blog/scrollbars-in-web-applications
- 8: https://answers.microsoft.com/en-us/windows/forum/all/why-is-scrolling-speedamount-inconsistent-across/d84ebe44-b4c9-40e5-9bd0-f4491f4a3527
- 9: https://theme.co/archive/forums/topic/website-doesnt-scroll-with-mouse-unless-i-use-sidebar/
- 10: https://support.google.com/chrome/thread/235560061/scrolling-doesn-t-work-on-a-website?hl=en
UI Behavior Verification Required
Based on the known issues with slider scrolling behavior—such as scroll chaining, CSS overflow conflicts, and touch event interference—it is imperative that the changes documented in the changelog (lines 26–29) be thoroughly tested across a variety of browsers and devices. Verify that:
- The slider becomes scrollable only when focused and that parent scrolling is effectively prevented.
- CSS properties (e.g.,
overscroll-behaviorand related overflow settings) are correctly applied without causing unintended side effects.- Touch interactions on mobile devices do not lead to unexpected scroll behavior or usability issues.
Please ensure that these UI improvements meet the intended functionality without negatively impacting the overall user experience.
| ### Removed | ||
| - Removed the feature to downsample existing volume annotations. All new volume annotations had a whole mag stack since [#4755](https://github.com/scalableminds/webknossos/pull/4755) (four years ago). [#7917](https://github.com/scalableminds/webknossos/pull/7917) |
There was a problem hiding this comment.
💡 Verification agent
❓ Verification inconclusive
Breaking change needs documentation update
The removal of the feature to downsample existing volume annotations is a breaking change that should be documented in the migration guide.
Let's check if this is properly documented:
🏁 Script executed:
#!/bin/bash
# Check if the migration guide mentions this breaking change
grep -A 5 "downsample" MIGRATIONS.released.mdLength of output: 45
Documentation Update Required: Breaking Change
The migration guide (MIGRATIONS.released.md) does not include any reference to the removal of downsampling for existing volume annotations. Since this change is breaking, please update the migration guide to document the removal of the downsampling feature (referencing #4755 and #7917).
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
38-38: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
2 participants
