Review Board 5.0.4 Release Notes¶
Release date: March 28, 2023
Installation/Upgrade¶
Review Board 5.0.4 is compatible with Python 3.7-3.11.
Follow our installation guide to prepare your system for Review Board or to upgrade your existing install.
To install this release, run:
$ pip3 install ReviewBoard==5.0.4
To learn more, see:
For assistance with your server, talk to us about support.
Compatibility Changes¶
We’ve fixed several compatibility issues found throughout Review Board 5. Details on these changes can be found in sections below.
Renamed the root-level links to the “all reviews” and “all comments” APIs introduced in Review Board 5.
Fixed a regression in the default Apache configuration generated by rb-site install.
Fixed compatibility issues with Review Bot 3.x.
Fixed compatibility issues with Elasticsearch 7.
Our Docker images now include libraries needed for Single Sign-On support.
Web API¶
Renamed the new “all reviews” and “all comments” APIs introduced in Review Board 5.
We made the hard decision to rename the links on the root of the API for the following APIs:
Renamed the Root Reviews API link from
reviews
toall_reviews
Renamed the Root Diff Comments API link from
diff_comments
toall_diff_comments
Renamed the Root General Comments API link from
general_comments
toall_general_comments
.Renamed the Root File Attachment Comments API link from
file_attachment_comments
toall_file_attachment_comments
.
The old link names conflicted with existing URI template names, causing consumers of the old names to encounter conflicts. Since these APIs are relatively new, we’ve decided it’s better to rename them rather than impact older clients.
Fixed a regression in diff-related APIs where syntax highlighting could not be disabled.
This regressed in Review Board 5.0.2 and 5.0.3 regressed. It impacted some of Review Bot’s code checking tools, and may have impacted other tools and services as well.
Bug Fixes¶
Installation¶
Fixed a regression in the default Apache configuration generated by rb-site install.
Review Board 5.0.3 included several new default web server configurations when creating a new site. However, it also regressed the Apache configuration when using Apache 2.4 or higher.
The corrected examples were available on the Creating a Review Board Site documentation, and a corrected template is now shipped with this release.
Diff Viewer¶
Fixed a bad summary in the Trojan Source warning banner.
The Trojan Source warning banner no longer mentions invisible characters may be present in the summary if there are no invisible characters.
Fixed bad links to the CVE reports in the Trojan Source warning banner.
Due to a rendering issue, the links weren’t all pointing to valid CVE reports.
Review Requests¶
Newlines in the bugs field are now stripped, avoiding bad bug IDs.
Search¶
Fixed compatibility issues with Elasticsearch 7.
The search backend used by Review Board contains a compatibility bug when searching some fields in Elasticsearch 7. We’ve worked around this in this release.
Improved assistance when dealing with incompatible Elasticsearch configurations.
The Elasticsearch configuration form has been improved to better help provide guidance when incompatible elasticsearch modules are installed or fail to load.
Single Sign-On¶
Fixed crashes when redirecting or linking a user account after a SAML login.
Fixed retaining the login URL when a SSO backend is configured for automatic login.
Automatic login is an experimental feature where visiting the standard login page automatically initiates Single Single Sign-On without having to click a button. Contact support to learn more.
Contributors¶
Christian Hammond
David Trowbridge
Michelle Aubin