From 52c9929d6395786a3e4b479ba8b50d4335327d9e Mon Sep 17 00:00:00 2001 From: Christian Hammond Date: Tue, 23 May 2023 14:05:25 -0700 Subject: [PATCH] Add release notes for RBTools 4.1. This release adds improvements for Perforce, ClearCase/VersionVault, Windows, and SSL certificate management, along with bug fixes. Testing Done: Built the docs. Checked for build errors, spelling errors, and bad links. Reviewed at https://reviews.reviewboard.org/r/13052/ --- docs/releasenotes/4.1.rst | 122 ++++++++++++++++++++++++++++++++++++ docs/releasenotes/index.rst | 1 + 2 files changed, 123 insertions(+) create mode 100644 docs/releasenotes/4.1.rst diff --git a/docs/releasenotes/4.1.rst b/docs/releasenotes/4.1.rst new file mode 100644 index 00000000..4b2e199c --- /dev/null +++ b/docs/releasenotes/4.1.rst @@ -0,0 +1,122 @@ +.. default-intersphinx:: rbt4.x rb-latest + + +========================= +RBTools 4.1 Release Notes +========================= + +**Release date:** TBD + + +New Features +============ + +Ready for Review Board 6 +======================== + +This release contains fixes and enhancements for the upcoming release of +Review Board 6. + +We recommend upgrading to RBTools 4.1 ahead of time in order to have the best +experience when upgrading to Review Board 6. + + +SSL Improvements +---------------- + +* Made it easier to work with SSL certificates and diagnose issues. + + RBTools now ships up-to-date root SSL certificates, which makes it easier + to work with newer SSL certificates on older Python installs. + + When SSL issues occur, a complete description of what went wrong and how + to address the issue is displayed. This includes information on how to + register self-signed certificates with Python, and how to update root + certificates. + + +Perforce +-------- + +* Added a Perforce trigger script to check review requests on submit, stamp + them, and close them. + + This can be installed by Perforce administrators to: + + 1. Check that a review request has been reviewed and approved before + accepting it. + + This defaults to a "Ship It!" with no open issues, but this can be + :ref:`customized by extensions `. + + 2. Update the changeset with the URL to the review request. + + 3. Close the review request once submitted. + + See the `trigger script`_ and :ref:`rbtools-workflow-perforce` for more + information. + + +.. _trigger script: + https://github.com/reviewboard/rbtools/blob/release-4.x/contrib/tools/p4-trigger-script + + +Windows +------- + +* The Windows installer now includes GNU Diff. + + GNU Diff is an important component needed to generate diffs for many types + of repositories. It previously had to be installed separately, but is now + available as part of RBTools for Windows. + +* The Windows installer has been updated from Python 3.10.8 to 3.10.11. + + +Bug Fixes +========= + +API +--- + +* Fixed issues with over-aggressive caching with the Review Board API + depending on the caching headers used. + + This will be important for Review Board 6. + + +IBM ClearCase / HCL VersionVault +-------------------------------- + +* Fixed generating diffs containing moved files. + +* Fixed generating diffs for UCM activities containing changes present in + other VOBs. + +* Fixed consistency issues when generating information on changesets. + + This is mostly an internal fix, but helps ensure that there's no differences + between two attempts at generating the same changeset. + + +Perforce +-------- + +* Fixed stamping of Perforce changesets. + + When using the `trigger script`_, :rbtcommand:`rbt land`, or + :rbtcommand:`rbt stamp`, the description could previously end up malformed. + + +Packaging +========= + +* Added a dependency on :pypi:`certifi` >= 2023.5.7. + + +Contributors +============ + +* Christian Hammond +* David Trowbridge +* Michelle Aubin diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst index 1802b9df..972607e3 100644 --- a/docs/releasenotes/index.rst +++ b/docs/releasenotes/index.rst @@ -11,6 +11,7 @@ RBTools Release Notes .. toctree:: :maxdepth: 1 + 4.1 4.0