Skip to content

Conversation

philippotto
Copy link
Member

(Please delete unneeded items, merge only when none are left open)

@philippotto philippotto requested a review from fm3 April 22, 2025 14:02
@philippotto philippotto self-assigned this Apr 22, 2025
Copy link
Contributor

coderabbitai bot commented Apr 22, 2025

📝 Walkthrough

Walkthrough

This change finalizes the release documentation for version 25.04.0, adding new entries to the changelog and migration guides to reflect features, fixes, performance improvements, and breaking changes introduced in this version. The unreleased changelog and migration documents are cleared of prior entries and updated to compare against the new release. Notable updates include mesh opacity control, dataset mirroring, backend and frontend dependency upgrades, a switch to Vitest testing framework requiring Node.js 22+, and removal of the top-level docker-compose.yml in favor of one under tools/hosting/. Migration notes specify FossilDB 0.1.37 and NodeJs 22+ requirements.

Changes

Files Change Summary
CHANGELOG.released.md Added release entry for 25.04.0 with detailed new features, performance improvements, bug fixes, breaking changes, and references to PRs/issues.
CHANGELOG.unreleased.md Updated commit comparison range to 25.04.0...HEAD and removed all prior unreleased entries, leaving only section headers.
MIGRATIONS.released.md Added migration entry for 25.04.0 specifying FossilDB 0.1.37 and NodeJs 22+ requirements, no Postgres evolutions.
MIGRATIONS.unreleased.md Updated commit comparison range to 25.04.0...HEAD and removed migration notes for FossilDB 0.1.37 and NodeJs 22+.

Possibly related PRs

Suggested reviewers

  • normanrz

Poem

🐇
A fresh new version hops along,
With meshes shaded, colors strong.
Node and FossilDB step up the pace,
Docker files find a new home base.
Tests now run with Vitest’s cheer,
Bugs fixed, features drawing near!
🥕


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.
    • 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 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.

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

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

12-12: Use correct spelling for Node.js
The official name is “Node.js”, not “NodeJs”. Please update the migration note.

- NodeJs version `22+` is required. [#8479](https://github.com/scalableminds/webknossos/pull/8479)
+ Node.js version `22+` is required. [#8479](https://github.com/scalableminds/webknossos/pull/8479)
🧰 Tools
🪛 LanguageTool

[uncategorized] ~12-~12: The official spelling of this programming framework is “Node.js”.
Context: ...m//pull/8460) - NodeJs version 22+ is required. [#8479](http...

(NODE_JS)


14-14: Remove trailing punctuation from heading
Markdown headings should not end with punctuation. Please drop the colon.

- ### Postgres Evolutions:
+ ### Postgres Evolutions
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

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

(MD026, no-trailing-punctuation)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c5847b7 and be84039.

📒 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)
🧰 Additional context used
🪛 LanguageTool
MIGRATIONS.released.md

[uncategorized] ~12-~12: The official spelling of this programming framework is “Node.js”.
Context: ...m//pull/8460) - NodeJs version 22+ is required. [#8479](http...

(NODE_JS)

🪛 markdownlint-cli2 (0.17.2)
MIGRATIONS.released.md

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

(MD026, no-trailing-punctuation)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: frontend-tests
  • GitHub Check: build-smoketest-push
  • GitHub Check: backend-tests
🔇 Additional comments (8)
CHANGELOG.released.md (6)

10-11: LGTM - Release entry has proper version and date format

The version number and date are properly formatted, and the commits comparison link is correctly structured.


13-16: LGTM - Well-documented highlights section

The highlights section effectively summarizes the most important changes in this release, with proper PR references.


17-23: LGTM - Clear additions with appropriate references

The added features and improvements are well-documented with corresponding PR links.


24-31: LGTM - Changed behaviors properly documented

Changed behaviors and improvements are clearly described with appropriate PR references.


32-43: LGTM - Bug fixes well-documented

The fixed issues are clearly described with appropriate PR references, providing users with clear information about what has been addressed in this release.


44-46: LGTM - Breaking change properly documented

The breaking change regarding docker-compose.yml relocation is clearly identified with the corresponding PR reference.

MIGRATIONS.released.md (1)

9-9: Version mismatch between PR and migration guide
The migration guide documents release 25.04.1, but the PR title/summary indicates preparing release 25.04.0. Please confirm the intended release version.

MIGRATIONS.unreleased.md (1)

9-9: Verify commit comparison range
The unreleased migration guide now compares from 25.04.1...HEAD. Confirm this aligns with your intended next release (currently stated as 25.04.0 in PR summary) or update accordingly.

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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between be84039 and 724244e.

📒 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
🚧 Files skipped from review as they are similar to previous changes (2)
  • CHANGELOG.unreleased.md
  • CHANGELOG.released.md
🧰 Additional context used
🪛 LanguageTool
MIGRATIONS.released.md

[uncategorized] ~12-~12: The official spelling of this programming framework is “Node.js”.
Context: ...m//pull/8460) - NodeJs version 22+ is required. [#8479](http...

(NODE_JS)

🪛 markdownlint-cli2 (0.17.2)
MIGRATIONS.released.md

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

(MD026, no-trailing-punctuation)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: backend-tests
  • GitHub Check: frontend-tests
  • GitHub Check: build-smoketest-push
🔇 Additional comments (2)
MIGRATIONS.released.md (2)

9-10: Release entry formatting looks good
The new release heading for 25.04.0 and its commit comparison link are correctly formatted and positioned before the previous 25.03.1 entry.


11-11: FossilDB version requirement is accurate
The specified FossilDB version 0.1.37 and Docker Hub tag master__525: correctly reflect the breaking change introduced in PR #8460.

## [25.04.0](https://github.com/scalableminds/webknossos/releases/tag/25.04.0) - 2025-04-22
[Commits](https://github.com/scalableminds/webknossos/compare/25.03.1...25.04.0)
- New FossilDB version `0.1.37` (`master__525:` on dockerhub) is required. [#8460](https://github.com/scalableminds/webknossos/pull/8460)
- NodeJs version `22+` is required. [#8479](https://github.com/scalableminds/webknossos/pull/8479)
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

Correct Node.js naming and verify cleanup of unreleased guide
The term “NodeJs” should be updated to “Node.js” to match the official spelling. Additionally, please ensure that these released requirements (FossilDB 0.1.37 and Node.js 22+) have been removed from MIGRATIONS.unreleased.md.

- NodeJs version `22+` is required. [#8479]
+ Node.js version `22+` is required. [#8479]

To verify that the unreleased guide no longer contains these entries, you can run:


🏁 Script executed:

#!/bin/bash
# Verify MIGRATIONS.unreleased.md no longer mentions the released requirements
rg -n "FossilDB version.*0\.1\.37" MIGRATIONS.unreleased.md
rg -n "NodeJs version.*22" MIGRATIONS.unreleased.md

Length of output: 115


🏁 Script executed:

#!/bin/bash
# List all migration guide markdown files
fd --type f 'MIGRATIONS.*\.md'

# If the unreleased guide exists, search for any lingering references
if [ -f MIGRATIONS.unreleased.md ]; then
  echo "=== Searching in MIGRATIONS.unreleased.md ==="
  rg -n '0\.1\.37' MIGRATIONS.unreleased.md
  rg -n -i 'FossilDB' MIGRATIONS.unreleased.md
  rg -n '22\+' MIGRATIONS.unreleased.md
  rg -n -i 'Node' MIGRATIONS.unreleased.md
else
  echo "MIGRATIONS.unreleased.md not found"
fi

Length of output: 389


Spelling correction in released migration guide
Please update the Node.js spelling in MIGRATIONS.released.md (line 12):

- NodeJs version `22+` is required. [#8479]
+ Node.js version `22+` is required. [#8479]

MIGRATIONS.unreleased.md has been verified and no longer contains any references to FossilDB 0.1.37 or NodeJs 22+, so no further cleanup is needed there.

Committable suggestion skipped: line range outside the PR's diff.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~12-~12: The official spelling of this programming framework is “Node.js”.
Context: ...m//pull/8460) - NodeJs version 22+ is required. [#8479](http...

(NODE_JS)

@philippotto philippotto merged commit acc8b93 into master Apr 23, 2025
5 checks passed
@philippotto philippotto deleted the prepare-25.04.0 branch April 23, 2025 09:26
@coderabbitai coderabbitai bot mentioned this pull request Apr 29, 2025
7 tasks
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