Release 25.01.0 #8346
Release 25.01.0 #8346
Conversation
philippotto
commented
Jan 22, 2025
philippotto
commented
- Updated changelog
- Updated migration guide if applicable
📝 WalkthroughWalkthroughThis pull request introduces version 25.01.0 of WEBKNOSSOS, featuring significant updates across multiple documentation files. The changes encompass new features like a "Restrict Floodfill" mode, segment visibility options, and tool improvements. The update includes performance optimizations, bug fixes, and removal of legacy API support. Configuration options have been renamed, and database evolution scripts have been added to support new functionality. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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 (
|
![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
📜 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(1 hunks)MIGRATIONS.unreleased.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- MIGRATIONS.unreleased.md
🧰 Additional context used
🪛 Markdownlint (0.37.0)
MIGRATIONS.released.md
15-15: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: circleci_build
🔇 Additional comments (9)
CHANGELOG.unreleased.md (1)
11-11: LGTM! Version reference is correctly updated.The version reference in the unreleased changelog has been properly updated to point to the new release version 25.01.0.
MIGRATIONS.released.md (3)
12-12: Dependency Update: New FossilDB version requirement.The required FossilDB version has been updated to 0.1.33 with the specific docker image tag.
Let's verify the docker image exists:
✅ Verification successful
Docker image verification successful
The specified FossilDB docker imagescalableminds/fossildb:master__504exists on Docker Hub and is actively maintained. The image was last pulled on January 21, 2025, indicating it's currently in use and accessible.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify the docker image exists on Docker Hub curl -s "https://hub.docker.com/v2/repositories/scalableminds/fossildb/tags/master__504/"Length of output: 905
13-13: Configuration Update: Renamed datastore options.The configuration options have been renamed for better clarity:
datastore.baseFolder→datastore.baseDirectorylocalFolderWhitelist→localDirectoryWhitelistThis change improves consistency with dashboard folders terminology.
Let's check for any remaining references to the old config names:
✅ Verification successful
Configuration rename verification successful
The old config names (
datastore.baseFolderandlocalFolderWhitelist) are only present in changelog and migration documentation files, where they are expected to remain as historical records. No instances found in active code or configuration files.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for old config names rg -i "baseFolder|localFolderWhitelist"Length of output: 1059
15-17: Database Updates: New evolution scripts added.Two new Postgres evolution scripts have been added:
124-decouple-dataset-directory-from-name.sql125-allow-dollar-in-layer-names.sqlThese scripts support the new features mentioned in the changelog.
Let's verify the evolution scripts exist and are properly formatted:
✅ Verification successful
Evolution scripts verified and properly structured
The evolution scripts exist and are properly implemented with:
- Atomic transactions with version assertions
- Proper sequential versioning (124 -> 125)
- Clear, focused changes matching their descriptions
- Appropriate constraints and indexing
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Check if the evolution scripts exist and contain both up/down migrations for script in 124-decouple-dataset-directory-from-name.sql 125-allow-dollar-in-layer-names.sql; do echo "Checking $script..." if [ -f "conf/evolutions/$script" ]; then grep -E "^-- !Ups|^-- !Downs" "conf/evolutions/$script" else echo "Script $script not found!" fi doneLength of output: 737
Script:
#!/bin/bash # Search for the evolution files or similar files echo "Searching for exact files:" fd -e sql "124-decouple-dataset-directory-from-name.sql|125-allow-dollar-in-layer-names.sql" echo -e "\nSearching for similar SQL files:" fd -e sql "124|125" echo -e "\nSearching for content related to these migrations:" rg -i "decouple.+dataset|dollar.+layer" -g "*.sql"Length of output: 926
Script:
#!/bin/bash echo "=== Content of 124-decouple-dataset-directory-from-name.sql ===" cat conf/evolutions/124-decouple-dataset-directory-from-name.sql echo -e "\n=== Content of 125-allow-dollar-in-layer-names.sql ===" cat conf/evolutions/125-allow-dollar-in-layer-names.sqlLength of output: 1836
🧰 Tools
🪛 Markdownlint (0.37.0)
15-15: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
CHANGELOG.released.md (5)
10-12: LGTM: Version header follows standard formatThe version header correctly includes:
- Version number following Calendar Versioning
- Release date
- Link to GitHub release tag and commits comparison
13-16: LGTM: Highlights section effectively summarizes key changesThe highlights section concisely presents the most important changes with clear descriptions and PR references.
18-27: LGTM: Added section properly documents new featuresEach addition is well-documented with:
- Clear description of the feature
- Reference to PR number
- Consistent formatting
29-37: LGTM: Changed section clearly describes modificationsThe changes are documented with appropriate detail and PR references.
39-60: LGTM: Fixed section comprehensively lists bug fixesBug fixes are well documented with:
- Clear description of the issue fixed
- Reference to PR number
- Consistent formatting
2 participants
