Skip to content

Conversation

@denialhaag
Copy link
Contributor

@denialhaag denialhaag commented Oct 15, 2025

Description

This PR prepares the release of v3.4.0.

Checklist:

  • The pull request only contains commits that are focused and relevant to this change.
  • I have added appropriate tests that cover the new/changed functionality.
  • I have updated the documentation to reflect these changes.
  • I have added entries to the changelog for any noteworthy additions, changes, fixes, or removals.
  • I have added migration instructions to the upgrade guide (if needed).
  • The changes follow the project's style guidelines and introduce no new warnings.
  • The changes are fully tested and pass the CI checks.
  • I have reviewed my own code changes.

Summary by CodeRabbit

  • Documentation
    • Added 3.4.0 (unreleased) section with upgrade notes and release links.
    • Noted end of support for Python 3.9 and added a testing note for Python 3.14.
    • Clarified and reorganized changelog entries; removed “Breaking” labels where not applicable.
    • Updated version comparison and release references to include 3.4.0 and adjusted cross-links.

@denialhaag denialhaag self-assigned this Oct 15, 2025
@denialhaag denialhaag added the documentation Improvements or additions to documentation label Oct 15, 2025
@github-project-automation github-project-automation bot moved this to In Progress in MQT Compilation Oct 15, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 15, 2025

📝 Walkthrough

Walkthrough

Adds v3.4.0 entries to CHANGELOG.md and UPGRADING.md (including a note about testing on Python 3.14), updates version comparison and unreleased links, notes end-of-support for Python 3.9, and reclassifies several prior “Breaking” bullets as non-breaking. No code or API changes.

Changes

Cohort / File(s) Summary of changes
Release docs
CHANGELOG.md, UPGRADING.md
Added v3.4.0 sections (Unreleased → 3.4.0); added note about testing on Python 3.14; recorded end-of-support for Python 3.9; removed explicit “Breaking” qualifiers from several changelog bullets and reformatted some entries; updated unreleased/version comparison links and bottom anchor links.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit nudges the changelog bright,
3.4.0 hops in, with links made right.
We wave to 3.9, a gentle goodbye,
and test on 3.14 beneath the sky.
Docs are tidy — carrot crumbs in sight.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title succinctly captures the primary purpose of the changeset by indicating that this PR prepares the v3.4.0 release, and it is directly related to the updates in CHANGELOG.md and UPGRADING.md without extraneous detail.
Description Check ✅ Passed The description includes the required “## Description” section with a clear summary of the change and a populated checklist matching the repository template, and it appropriately omits the “Fixes #” line since no issue is being closed.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch prepare-release-3-4-0

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e5329e0 and 880e979.

📒 Files selected for processing (1)
  • CHANGELOG.md (4 hunks)
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md

[grammar] ~12-~12: Use correct spacing
Context: ...## [Unreleased] ## [3.4.0] - 2025-10-15 _If you are upgrading: please see [`UPGRA...

(QB_NEW_EN_OTHER_ERROR_IDS_5)


[grammar] ~14-~14: Use colons correctly
Context: ...] ## [3.4.0] - 2025-10-15 _If you are upgrading: please see [UPGRADING.md](UPGRADING.m...

(QB_NEW_EN_OTHER_ERROR_IDS_30)


[grammar] ~14-~14: Use correct spacing
Context: ... see UPGRADING.md._ ### Added - 👷 Enable testing on Python 3.1...

(QB_NEW_EN_OTHER_ERROR_IDS_5)


[grammar] ~52-~52: Use correct spacing
Context: ...ative_enum` ([#715]) ([@denialhaag]) ### Fixed - 🚸 Make function to export arch...

(QB_NEW_EN_OTHER_ERROR_IDS_5)


[grammar] ~65-~65: There might be a mistake here.
Context: ...uce modules ([#665]) ([@denialhaag]) - ♻️ Restructure the C++ code for the Pyth...

(QB_NEW_EN)


[grammar] ~66-~66: There might be a mistake here.
Context: ...hon modules ([#665]) ([@denialhaag]) - ⬆️ Bump minimum required mqt-core vers...

(QB_NEW_EN)


[grammar] ~67-~67: There might be a mistake here.
Context: ... to 3.1.0 ([#694]) ([@denialhaag]) - ⬆️ Bump minimum required pybind11 vers...

(QB_NEW_EN)


[grammar] ~68-~68: Use correct spacing
Context: ... to 3.0.0 ([#694]) ([@denialhaag]) ### Fixed - 🐛 Fix out-of-bounds access to ...

(QB_NEW_EN_OTHER_ERROR_IDS_5)


[grammar] ~120-~120: There might be a mistake here.
Context: ...ich-quantum-toolkit] GitHub organization - ♻️ Use the mqt-core Python package for...

(QB_NEW_EN)


[grammar] ~121-~121: There might be a mistake here.
Context: ...ng circuits ([#418]) ([@burgholzer]) - ⬆️ Bump minimum required CMake version t...

(QB_NEW_EN)


[grammar] ~122-~122: There might be a mistake here.
Context: ...to 3.24.0 ([#621]) ([@burgholzer]) - ♻️ Adopt new NAComputation in NASP too...

(QB_NEW_EN)


[grammar] ~123-~123: There might be a mistake here.
Context: ...n` in NASP tool ([#608]) ([@ystade]) - ♻️ Isolate NALAC from the main library (...

(QB_NEW_EN)


[grammar] ~124-~124: There might be a mistake here.
Context: ...library ([#608], [#609]) ([@ystade]) - 📝 Rework existing project documentation...

(QB_NEW_EN)


[grammar] ~125-~125: There might be a mistake here.
Context: ...cumentation ([#614]) ([@burgholzer]) ### Removed - 🔥 Remove teleportation suppo...

(QB_NEW_EN)


[grammar] ~127-~127: Use correct spacing
Context: ...[#614]) ([@burgholzer]) ### Removed - 🔥 Remove teleportation support for the ...

(QB_NEW_EN_OTHER_ERROR_IDS_5)


[grammar] ~129-~129: There might be a mistake here.
Context: ...tic mapping ([#621]) ([@burgholzer]) - 🔥 Remove support for BackendV1 Qiskit...

(QB_NEW_EN)


[grammar] ~130-~130: There might be a mistake here.
Context: ...it backends ([#610]) ([@burgholzer]) - 🔥 Remove support for .real, .qc, `....

(QB_NEW_EN)


[grammar] ~131-~131: There might be a mistake here.
Context: ...GRCSfiles ([#621]) ([**@burgholzer**]) - 🔥 Removeyaml-cpp` dependency ([#608])...

(QB_NEW_EN)


[grammar] ~132-~132: There might be a mistake here.
Context: ...cpp` dependency ([#608]) ([@ystade]) ## [2.8.0] - 2024-11-18 _📚 Refer to the [G...

(QB_NEW_EN)


[grammar] ~134-~134: Use correct spacing
Context: ...([@ystade]) ## [2.8.0] - 2024-11-18 _📚 Refer to the [GitHub Release Notes] f...

(QB_NEW_EN_OTHER_ERROR_IDS_5)


[grammar] ~136-~136: There might be a mistake here.
Context: ... Release Notes] for previous changelogs._ [unreleased]: v3.4.0...HEAD [3.4.0]: https://github.com/munich-quantum-toolkit/qmap/releases/tag/v3.4.0 [3.3.1]: https://github.com/munich-quantum-toolkit/qmap/releases/tag/v3.3.1 [3.3.0]: https://github.com/munich-quantum-toolkit/qmap/releases/tag/v3.3.0 [3.2.0]: https://github.com/munich-quantum-toolkit/qmap/releases/tag/v3.2.0 [3.1.3]: https://github.com/munich-quantum-toolkit/qmap/releases/tag/v3.1.3 [3.1.2]: https://github.com/munich-quantum-toolkit/qmap/releases/tag/v3.1.2 [3.1.1]: https://github.com/munich-quantum-toolkit/qmap/releases/tag/v3.1.1 [3.1.0]: https://github.com/munich-quantum-toolkit/qmap/releases/tag/v3.1.0 [3.0.0]: https://github.com/munich-quantum-toolkit/qmap/releases/tag/v3.0.0 [2.8.0]: https://github.com/munich-quantum-toolkit/qmap/releases/tag/v2.8.0 [#804]: #804 [#803]: #803 [#796]: #796 [#793]: #793 [#767]: #767 [#760]: #760 [#728]: #728 [#720]: #720 [#719]: #719 [#717]: #717 [#715]: #715 [#714]: #714 [#713]: #713 [#712]: #712 [#694]: #694 [#665]: #665 [#661]: #661 [#660]: #660 [#659]: #659 [#624]: #624 [#621]: #621 [#614]: #614 [#610]: #610 [#609]: #609 [#608]: #608 [#418]: #418 [@burgholzer]: https://github.com/burgholzer [@ystade]: https://github.com/ystade [@denialhaag]: https://github.com/denialhaag [Keep a Changelog]: https://keepachangelog.com/en/1.1.0/ [Common Changelog]: https://common-changelog.org [Semantic Versioning]: https://semver.org/spec/v2.0.0.html [GitHub Release Notes]: https://github.com/munich-quantum-toolkit/qmap/releases [munich-quantum-toolkit]: https://github.com/munich-quantum-toolkit

(QB_NEW_EN)

🔇 Additional comments (3)
CHANGELOG.md (3)

12-15: Release header and upgrade note look good; verify the UPGRADING anchor exists.

  • Check UPGRADING.md contains a matching ## 3.4.0 anchor resolving to #340.
  • Confirm the date matches the actual release day if the tag slips.

140-141: Unreleased and 3.4.0 link updates LGTM.

Links align with existing style (compare for Unreleased; tag for release).


49-52: Historical entry polishing looks consistent.

Rewording/reordering across 3.3.0, 3.2.0, and 3.0.0 reads clean and preserves meaning.

Also applies to: 65-69, 120-133


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

@denialhaag denialhaag requested a review from burgholzer October 15, 2025 15:05
@denialhaag denialhaag merged commit c365948 into main Oct 15, 2025
20 checks passed
@denialhaag denialhaag deleted the prepare-release-3-4-0 branch October 15, 2025 15:48
@github-project-automation github-project-automation bot moved this from In Progress to Done in MQT Compilation Oct 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants