Skip to content

Conversation

fm3
Copy link
Member

@fm3 fm3 commented Jul 1, 2025

Update changelog + migration guide for release 25.07.0 based on current master

@fm3 fm3 self-assigned this Jul 1, 2025
Copy link
Contributor

coderabbitai bot commented Jul 1, 2025

📝 Walkthrough

Walkthrough

This update finalizes the 25.07.0 release of WEBKNOSSOS, consolidating changelog and migration guide entries from individual files into official documentation. It removes now-bundled unreleased change files, reflecting new features, improvements, bug fixes, database migrations, and workflow changes introduced in this release.

Changes

Files / Grouped Paths Change Summary
CHANGELOG.released.md, MIGRATIONS.released.md Added consolidated release notes and migration entries for version 25.07.0.
unreleased_changes/*.md Removed individual unreleased change files now merged into official changelog and migration guide.
tools/create-gh-release.py Removed Docker run instruction line from release header generation.

Possibly related PRs

Poem

🐇✨
A hop, a leap, a brand new release—
Changelogs bundled, migrations with ease.
Trees can duplicate, caches are clear,
Meshes and mappings bring formats near.
Bugs are squashed, the docs now neat,
WEBKNOSSOS 25.07.0—oh, what a treat!
🌿🎉


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e2bae33 and ae9ddaa.

📒 Files selected for processing (1)
  • tools/create-gh-release.py (0 hunks)
💤 Files with no reviewable changes (1)
  • tools/create-gh-release.py
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: frontend-tests
  • GitHub Check: backend-tests
  • GitHub Check: build-smoketest-push
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 marked this pull request as ready for review July 1, 2025 06:57
@fm3 fm3 requested a review from normanrz July 1, 2025 06:57
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: 0

🧹 Nitpick comments (6)
MIGRATIONS.released.md (2)

12-12: Spell out “WEBKNOSSOS” instead of the informal abbreviation “wk”.

Previous entries consistently use the full product name. Keeping the wording uniform improves the professional tone of the docs.

- - The default thread pool size was increased from 5 to 10 times the number of available CPUs (capped at 1000). Note that wk may need slightly more memory because of this.
+ - The default thread pool size was increased from 5 to 10 × the number of available CPUs (capped at 1000). Note that WEBKNOSSOS may require slightly more memory because of this.

14-14: Add the missing colon for heading consistency.

All neighbouring release sections use “### Postgres Evolutions:” (with a trailing colon). Align this heading to avoid accidental formatting drift.

-### Postgres Evolutions
+### Postgres Evolutions:
CHANGELOG.released.md (4)

14-24: Remove duplicated bullets between “Highlights” and “Added”.

Lines 14-16 are repeated verbatim in 22-24. Keeping both makes the changelog noisy without adding information.
Either keep them in “Highlights” only (preferred for quick overview) or move them exclusively to “Added”, but avoid duplication.

-### Added
-- Added the ability to duplicate trees ...
-- Added a new Account Settings page ...
+### Added
+<!-- (duplicates removed; already listed in Highlights) -->

37-38: Mis-categorised & duplicated entry.

“Improved efficiency of saving bounding box related annotation changes” appears in “Highlights” (line 16) and again in “Fixed” (line 37).
It is an improvement, not a bug-fix. Move it under “Changed/Improved” and drop the duplicate.

-### Fixed
-- Improved efficiency of saving bounding box related annotation changes. [#8492](...)
+### Changed
+- Improved efficiency of saving bounding-box related annotation changes. [#8492](...)

31-31: Minor wording tweak.

“organizations settings page” should be singular (“organization settings page”) to match the UI label.

- Updated the UI for the organizations settings page.
+ Updated the UI for the organization settings page.

30-30: Standardise quotes to ASCII.

The bullet uses curly quotes around path. Stick to plain " for consistency with the rest of the document.

- ... includes an explicit “path” attribute ...
+ ... includes an explicit "path" attribute ...
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 47a97ec and e2bae33.

📒 Files selected for processing (34)
  • CHANGELOG.released.md (1 hunks)
  • MIGRATIONS.released.md (2 hunks)
  • unreleased_changes/8492.md (0 hunks)
  • unreleased_changes/8518.md (0 hunks)
  • unreleased_changes/8542.md (0 hunks)
  • unreleased_changes/8598.md (0 hunks)
  • unreleased_changes/8622.md (0 hunks)
  • unreleased_changes/8633.md (0 hunks)
  • unreleased_changes/8638.md (0 hunks)
  • unreleased_changes/8662.md (0 hunks)
  • unreleased_changes/8672.md (0 hunks)
  • unreleased_changes/8676.md (0 hunks)
  • unreleased_changes/8677.md (0 hunks)
  • unreleased_changes/8679.md (0 hunks)
  • unreleased_changes/8682.md (0 hunks)
  • unreleased_changes/8683.md (0 hunks)
  • unreleased_changes/8686.md (0 hunks)
  • unreleased_changes/8687.md (0 hunks)
  • unreleased_changes/8688.md (0 hunks)
  • unreleased_changes/8695.md (0 hunks)
  • unreleased_changes/8698.md (0 hunks)
  • unreleased_changes/8702.md (0 hunks)
  • unreleased_changes/8703.md (0 hunks)
  • unreleased_changes/8705.md (0 hunks)
  • unreleased_changes/8709.md (0 hunks)
  • unreleased_changes/8710.md (0 hunks)
  • unreleased_changes/8716.md (0 hunks)
  • unreleased_changes/8720.md (0 hunks)
  • unreleased_changes/8721.md (0 hunks)
  • unreleased_changes/8725.md (0 hunks)
  • unreleased_changes/8726.md (0 hunks)
  • unreleased_changes/8727.md (0 hunks)
  • unreleased_changes/8728.md (0 hunks)
  • unreleased_changes/8733.md (0 hunks)
💤 Files with no reviewable changes (32)
  • unreleased_changes/8492.md
  • unreleased_changes/8683.md
  • unreleased_changes/8705.md
  • unreleased_changes/8727.md
  • unreleased_changes/8687.md
  • unreleased_changes/8676.md
  • unreleased_changes/8662.md
  • unreleased_changes/8726.md
  • unreleased_changes/8709.md
  • unreleased_changes/8702.md
  • unreleased_changes/8710.md
  • unreleased_changes/8672.md
  • unreleased_changes/8598.md
  • unreleased_changes/8725.md
  • unreleased_changes/8688.md
  • unreleased_changes/8633.md
  • unreleased_changes/8703.md
  • unreleased_changes/8720.md
  • unreleased_changes/8716.md
  • unreleased_changes/8638.md
  • unreleased_changes/8677.md
  • unreleased_changes/8686.md
  • unreleased_changes/8695.md
  • unreleased_changes/8622.md
  • unreleased_changes/8682.md
  • unreleased_changes/8728.md
  • unreleased_changes/8733.md
  • unreleased_changes/8679.md
  • unreleased_changes/8542.md
  • unreleased_changes/8721.md
  • unreleased_changes/8518.md
  • unreleased_changes/8698.md
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: MichaelBuessemeyer
PR: scalableminds/webknossos#8221
File: CHANGELOG.unreleased.md:14-14
Timestamp: 2024-11-25T14:52:23.201Z
Learning: For the `webknossos` project, changelog entries in `CHANGELOG.unreleased.md` should be concise and avoid unnecessary detailed explanations.
MIGRATIONS.released.md (1)
Learnt from: MichaelBuessemeyer
PR: scalableminds/webknossos#8221
File: CHANGELOG.unreleased.md:14-14
Timestamp: 2024-11-25T14:52:23.201Z
Learning: For the `webknossos` project, changelog entries in `CHANGELOG.unreleased.md` should be concise and avoid unnecessary detailed explanations.
CHANGELOG.released.md (1)

undefined

<retrieved_learning>
Learnt from: MichaelBuessemeyer
PR: #8221
File: CHANGELOG.unreleased.md:14-14
Timestamp: 2024-11-25T14:52:23.201Z
Learning: For the webknossos project, changelog entries in CHANGELOG.unreleased.md should be concise and avoid unnecessary detailed explanations.
</retrieved_learning>

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: frontend-tests
  • GitHub Check: build-smoketest-push
  • GitHub Check: backend-tests

@fm3 fm3 merged commit 0c9bb64 into master Jul 1, 2025
5 checks passed
@fm3 fm3 deleted the prepare-release-25.07.0 branch July 1, 2025 07:55
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