Skip to content

docs: Update changelog for 0.16.4#1326

Merged
Czaki merged 3 commits intodevelopfrom
release_notes
Oct 21, 2025
Merged

docs: Update changelog for 0.16.4#1326
Czaki merged 3 commits intodevelopfrom
release_notes

Conversation

@Czaki
Copy link
Collaborator

@Czaki Czaki commented Oct 21, 2025

Summary by Sourcery

Update the changelog for version 0.16.4 with the correct release date and include all notable feature additions, dependency upgrades, formatting changes, and security bumps.

New Features:

  • Set units for viewer spawned from the view menu
  • Add saving color maps in SOME TIFFs
  • Add saving and reading of time scale in ImageJ and SOME TIFF files

Documentation:

  • Update changelog date and entries for 0.16.4

Tests:

  • Add automatic constraint upgrades for h5py, ipykernel, numpy, psygnal, pydantic, sentry-sdk, and tifffile

Chores:

  • Use ruff formatter instead of black
  • Bump github/codeql-action from v3 to v4

Summary by CodeRabbit

  • New Features

    • Added saving and reading of time scale in ImageJ and OME‑TIFF files.
  • Documentation

    • Updated changelog and release date for 0.16.4.
  • Testing/Automation

    • Enabled automatic dependency constraint upgrades.
  • Miscellaneous

    • Added typo/config entries for OME-related terms and updated commit preprocessing; formatter updated (ruff).
  • Security

    • Upgraded code scanning tooling to a newer version.

@Czaki Czaki added this to the 0.16.4 milestone Oct 21, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Oct 21, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR revises the changelog for 0.16.4 by updating the release date, refining feature entries, and adding new items across Documentation, Testing, Miscellaneous, and Security sections.

File-Level Changes

Change Details Files
Update release header date
  • Change version date from 2025-10-15 to 2025-10-21
changelog.md
Refine feature entries
  • Rename saving color maps target from OME to SOME TIFFs
  • Add entry for saving/reading time scale in ImageJ and SOME TIFFs
changelog.md
Add Documentation section
  • Insert Documentation header
  • Add changelog update entry under Documentation
changelog.md
Extend Testing section changelog.md
Expand Miscellaneous Tasks changelog.md
Update Security section changelog.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 21, 2025

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

Changelog and related config files updated: 0.16.4 release date adjusted; a feature entry for saving/reading time scale in ImageJ and OME‑TIFF files added; a new .typos.toml introduced and excluded from packaging; cliff.toml preprocessors adjusted (bracket-escape commented, typos preprocessor now references .typos.toml).

Changes

Cohort / File(s) Change Summary
Changelog
changelog.md
Updated 0.16.4 date (2025-10-15 → 2025-10-21); added feature "Add saving and reading of time scale in ImageJ and OME TIFF files"; added 📚 Documentation section; expanded testing/automation constraint-upgrade line (h5py, ipykernel, numpy, psygnal, pydantic, sentry-sdk, tifffile); added miscellaneous formatter (ruff) and changelog entries; bumped github/codeql-action 3→4.
Typos configuration
.typos.toml
New file added defining [default.extend-words] mappings for terms: OME, OME-TIFF, OME-XML, OMERO, Bio-Formats.
Packaging manifest
MANIFEST.in
Added rule excluding .typos.toml from packaged files.
Cliff configuration
cliff.toml
Commented-out commit_preprocessors line that escaped square-bracket patterns; updated typos preprocessor invocation to explicitly use --config .typos.toml (previous no-config line left commented).

Sequence Diagram(s)

sequenceDiagram
    autonumber
    participant User
    participant App as "App / CLI"
    participant IO as "Image (ImageJ / OME‑TIFF)"
    Note right of App #DDEEFF: Documented change — read/write time scale metadata
    User->>App: Open or Save image
    App->>IO: Read/Write metadata (time scale)
    IO-->>App: Return/Confirm time scale metadata
    App-->>User: Display/confirm persisted time scale
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰
I hopped through changelogs, neat and spry,
Tucked time scales in TIFFs — oh my!
Typos tamed and config snug,
A little hop, a grateful shrug,
Carrot crumbs of docs — bye-bye. 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "docs: Update changelog for 0.16.4" directly corresponds to the primary change in the pull request—updating changelog.md with the correct release date and new entries for version 0.16.4. While the changeset also includes configuration file updates (.typos.toml, MANIFEST.in, cliff.toml), these are supporting infrastructure changes to enable proper typos handling rather than the main objective. The title is specific, clear, and concise enough that teammates scanning the history would understand the primary purpose of the PR without ambiguity or vagueness.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 42c542b and 15cceea.

📒 Files selected for processing (4)
  • .typos.toml (1 hunks)
  • MANIFEST.in (1 hunks)
  • changelog.md (4 hunks)
  • cliff.toml (1 hunks)

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `changelog.md:10-11` </location>
<code_context>

 - Set units for viewer spawned from the view menu ([#1308](https://github.com/4DNucleome/PartSeg/pull/1308))
-- Add saving color maps in OME tiffs ([#1312](https://github.com/4DNucleome/PartSeg/pull/1312))
+- Add saving color maps in SOME tiffs ([#1312](https://github.com/4DNucleome/PartSeg/pull/1312))
+- Add saving and reading of time scale in ImageJ and SOME TIFF files ([#1323](https://github.com/4DNucleome/PartSeg/pull/1323))

 ### 🐛 Bug Fixes
</code_context>

<issue_to_address>
**issue (typo):** Possible typo: 'SOME tiffs' should likely be 'OME tiffs'.

Please clarify whether 'SOME TIFF' is correct or if it should be 'OME-TIFF'.

```suggestion
- Add saving color maps in OME tiffs ([#1312](https://github.com/4DNucleome/PartSeg/pull/1312))
- Add saving and reading of time scale in ImageJ and OME TIFF files ([#1323](https://github.com/4DNucleome/PartSeg/pull/1323))
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@sonarqubecloud
Copy link

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 (1)
changelog.md (1)

21-23: Reconsider the self-referential Documentation entry.

Line 23 documents "Update changelog for 0.16.4"—an entry about updating the changelog that appears in the changelog itself. This is somewhat circular and may clutter the release notes. Consider either removing this entry or moving it to the Miscellaneous Tasks section if it's intended to highlight the release notes maintenance work.

If this entry is necessary, consider moving it to the Miscellaneous Tasks section (after line 38) for better categorization, or remove it entirely if it's not user-facing value.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d92ebc8 and 15cceea.

📒 Files selected for processing (4)
  • .typos.toml (1 hunks)
  • MANIFEST.in (1 hunks)
  • changelog.md (4 hunks)
  • cliff.toml (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • .typos.toml
  • MANIFEST.in
⏰ Context from checks skipped due to timeout of 900000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (16)
  • GitHub Check: Base py3.11 / macos-15-intel py 3.11 latest PyQt5
  • GitHub Check: 4DNucleome.PartSeg (Tests_linux test_linux)
  • GitHub Check: 4DNucleome.PartSeg (Builds pyinstaller windows)
  • GitHub Check: 4DNucleome.PartSeg (Builds pyinstaller macos_arm)
  • GitHub Check: 4DNucleome.PartSeg (Tests_other test windows)
  • GitHub Check: 4DNucleome.PartSeg (Builds pyinstaller macos)
  • GitHub Check: 4DNucleome.PartSeg (Tests_other test macos)
  • GitHub Check: 4DNucleome.PartSeg (Builds sdist)
  • GitHub Check: 4DNucleome.PartSeg (Builds pyinstaller_linux)
  • GitHub Check: 4DNucleome.PartSeg (formatting_check check_formating)
  • GitHub Check: 4DNucleome.PartSeg (GetTestData linux)
  • GitHub Check: 4DNucleome.PartSeg (manifest_check manifest_check)
  • GitHub Check: 4DNucleome.PartSeg (Documentation_check help)
  • GitHub Check: 4DNucleome.PartSeg (Documentation_check Notebook_check)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: Sourcery review
🔇 Additional comments (1)
cliff.toml (1)

50-57: Configuration update aligns with .typos.toml integration.

The changes to disable the square-bracket escape pattern (line 53) and explicitly point the typos preprocessor to the new .typos.toml config (line 56) are appropriate. This ensures spell-checking uses the local terminology extensions (OME, OME-TIFF, etc.) during commit message preprocessing.

@Czaki
Copy link
Collaborator Author

Czaki commented Oct 21, 2025

@coderabbitai help

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 21, 2025

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

CodeRabbit commands

These commands are invoked using PR/Issue 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 evaluate custom pre-merge check --instructions <custom-checks-instructions> --name <custom-checks-title> [--mode <error|warning>] to validate the custom pre-merge checks instructions. Defaults to error when --mode is omitted.
    • @coderabbitai ignore pre-merge checks to override pre-merge checks and get an approval on PR.
    • @coderabbitai run pre-merge checks to run pre-merge checks on the pull request.
  • @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 generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve to 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 or @coderabbit 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.

Status, support, documentation and community

  • Visit our status page to check the current availability of CodeRabbit.
  • Create a ticket on our support page for assistance with any issues or questions.
  • Visit our documentation site for detailed information on how to use CodeRabbit.
  • Join our Discord community to connect with other users and get help from the community.
  • Follow us on X/Twitter for updates and announcements.

@Czaki
Copy link
Collaborator Author

Czaki commented Oct 21, 2025

@coderabbitai summary

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 21, 2025

✅ Actions performed

Summary regeneration triggered.

@Czaki Czaki merged commit bcd168d into develop Oct 21, 2025
60 checks passed
@Czaki Czaki deleted the release_notes branch October 21, 2025 12:01
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.

1 participant

Comments