Skip to content

Remove review-to-comment migration#15609

Merged
Siedlerchr merged 3 commits into
mainfrom
keep-review-field
Apr 22, 2026
Merged

Remove review-to-comment migration#15609
Siedlerchr merged 3 commits into
mainfrom
keep-review-field

Conversation

@koppor

@koppor koppor commented Apr 21, 2026

Copy link
Copy Markdown
Member

This semantically reverts #3658

JabRef removed the field "review" and did not allow to put it back. This PR just removes the migration.

If anyone needs that again, they can use Copy or Move content.

Steps to test

  1. Open a .bib file in a text editor
  2. Add review to a bibEntry
  3. Start JabRef
  4. Open the BibEntry there
  5. See that BibEntry is same as on disk.

Checklist

  • I own the copyright of the code submitted and I license it under the MIT license
  • [/] I manually tested my changes in running JabRef (always required)
  • [/] I added JUnit tests for changes (if applicable)
  • [/] I added screenshots in the PR description (if change is visible to the user)
  • [/] I added a screenshot in the PR description showing a library with a single entry with me as author and as title the issue number
  • I described the change in CHANGELOG.md in a way that can be understood by the average user (if change is visible to the user)
  • [/] I checked the user documentation for up to dateness and submitted a pull request to our user documentation repository

@qodo-free-for-open-source-projects

Copy link
Copy Markdown
Contributor

Review Summary by Qodo

Remove automatic review-to-comment field migration

✨ Enhancement

Grey Divider

Walkthroughs

Description
• Removes automatic migration of review field to comment field
• Preserves review field in BibTeX files during import
• Eliminates user dialogs for field migration conflicts
• Users can now manually manage review field content
Diagram
flowchart LR
  A["Review Field in BIB File"] -->|Previously: Auto-migrated| B["Comment Field"]
  A -->|Now: Preserved| C["Review Field Kept"]
  D["Migration Code"] -->|Removed| E["Cleaner Codebase"]
Loading

Grey Divider

File Changes

1. jabgui/src/main/java/org/jabref/gui/importer/actions/MergeReviewIntoCommentAction.java Miscellaneous +0/-28

Remove review-to-comment migration action class

• Deleted entire action class that handled review-to-comment migration
• Removed logic for checking migration necessity and performing migration
• Eliminated user confirmation dialog handling for field conflicts

jabgui/src/main/java/org/jabref/gui/importer/actions/MergeReviewIntoCommentAction.java


2. jabgui/src/main/java/org/jabref/gui/importer/actions/MergeReviewIntoCommentConfirmationDialog.java Miscellaneous +0/-38

Remove migration confirmation dialog class

• Deleted dialog class that prompted users about field migration
• Removed conflict resolution UI for entries with both review and comment fields
• Eliminated localization strings for migration confirmation messages

jabgui/src/main/java/org/jabref/gui/importer/actions/MergeReviewIntoCommentConfirmationDialog.java


3. jabgui/src/main/java/org/jabref/gui/importer/actions/OpenDatabaseAction.java ✨ Enhancement +0/-3

Remove migration action from database opening flow

• Removed MergeReviewIntoCommentAction from POST_OPEN_ACTIONS list
• Deleted migration warning comment
• Simplified post-open action initialization

jabgui/src/main/java/org/jabref/gui/importer/actions/OpenDatabaseAction.java


View more (3)
4. jabgui/src/main/java/org/jabref/migrations/MergeReviewIntoCommentMigration.java Miscellaneous +0/-79

Remove review-to-comment migration logic class

• Deleted entire migration class handling review field conversion
• Removed logic for detecting entries needing migration
• Eliminated conflict detection and merging functionality
• Removed field update operations for review-to-comment conversion

jabgui/src/main/java/org/jabref/migrations/MergeReviewIntoCommentMigration.java


5. jabgui/src/test/java/org/jabref/migrations/MergeReviewIntoCommentActionMigrationTest.java 🧪 Tests +0/-96

Remove migration test suite

• Deleted all test cases for migration functionality
• Removed tests for review field handling, comment field handling, and conflicts
• Eliminated multi-line review field and field merging test cases

jabgui/src/test/java/org/jabref/migrations/MergeReviewIntoCommentActionMigrationTest.java


6. CHANGELOG.md 📝 Documentation +1/-0

Document review field preservation change

• Added entry documenting that JabRef now preserves review field in BibTeX files
• Noted change in unreleased version section

CHANGELOG.md


Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

qodo-free-for-open-source-projects Bot commented Apr 21, 2026

Copy link
Copy Markdown
Contributor

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider


Action required

1. Invalid CHANGELOG PR link📘 Rule violation ⚙ Maintainability
Description
The new CHANGELOG entry includes a placeholder PR reference
([#](https://github.com/JabRef/jabref/pull/)) and malformed inline code formatting for review,
which is not professional/precise user-facing release note formatting.
Code

CHANGELOG.md[53]

+- JabRef keeps the field ´review` in BibTeX files. [#](https://github.com/JabRef/jabref/pull/)
Evidence
PR Compliance ID 31 requires professional, consistently formatted release notes with valid
references. The added CHANGELOG line contains an invalid PR link target and malformed Markdown
inline code, violating those formatting requirements.

CHANGELOG.md[53-53]
Best Practice: Learned patterns

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The new `CHANGELOG.md` entry contains a placeholder/invalid PR link and malformed inline code formatting for the `review` field.
## Issue Context
Release notes must be professional and consistently formatted, with valid issue/PR references.
## Fix Focus Areas
- CHANGELOG.md[53-53]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

Comment thread CHANGELOG.md Outdated
@Siedlerchr

Siedlerchr commented Apr 22, 2026

Copy link
Copy Markdown
Member

@junie-agent fix the tests

@github-actions

github-actions Bot commented Apr 22, 2026

Copy link
Copy Markdown
Contributor

Junie is failed!

Details: ❌ Junie output file path is not set.

This indicates that Junie execution did not complete properly.
Please check the Junie execution logs above for error details.

View job run

@Siedlerchr

Copy link
Copy Markdown
Member

@junie-agent try again fixing the test

@github-actions

github-actions Bot commented Apr 22, 2026

Copy link
Copy Markdown
Contributor

Junie successfully finished!
PR link: #15612

Fix tests and update changelog for review field removal

Co-authored-by: junie-agent <247260674+junie-agent@users.noreply.github.com>
Co-authored-by: Siedlerchr <320228+Siedlerchr@users.noreply.github.com>
@Siedlerchr Siedlerchr added this pull request to the merge queue Apr 22, 2026
@github-actions github-actions Bot added the status: to-be-merged PRs which are accepted and should go into the merge-queue. label Apr 22, 2026
Merged via the queue into main with commit bc49dfd Apr 22, 2026
57 checks passed
@Siedlerchr Siedlerchr deleted the keep-review-field branch April 22, 2026 15:41
Siedlerchr added a commit that referenced this pull request Apr 22, 2026
* upstream/main:
  Remove review-to-comment migration (#15609)
  Chore(deps): Bump com.uber.nullaway:nullaway in /versions (#15615)
  Chore(deps): Bump javafx from 26 to 26.0.1 in /versions (#15614)
  Update dependency org.openjfx:javafx-base to v26.0.1 (#15608)
  Chore(deps): Bump org.openrewrite.rewrite from 7.30.0 to 7.31.0 (#15602)
  OpenOffice Refactor subtasks (#15380)
  Chore(deps): Bump org.hisp.dhis:json-tree in /versions (#15606)
  Chore(deps): Bump com.autonomousapps:dependency-analysis-gradle-plugin (#15604)
  Chore(deps): Bump com.autonomousapps:dependency-analysis-gradle-plugin (#15605)
  Chore(deps): Bump org.openrewrite.recipe:rewrite-recipe-bom (#15603)
  Fix hash warning (#15596)
  Update testlens (#15595)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: to-be-merged PRs which are accepted and should go into the merge-queue.

Projects

None yet

2 participants