Add draft release notes for Review Board 5.0.2

Review Request #12755 — Created Dec. 9, 2022 and updated

chipx86
Review Board
release-5.0.x
reviewboard

This change adds the release notes for the upcoming 5.0.2 release. This
provides a mix of new features and bug fixes.

Some notable new features include Trojan Source detection settings, API
token time-based expiration, enabling ACL support for diffs for
extensions, and reworked URI templates.

There are also fixes in the diff viewer, crashes fixes for upgrades, and
mimetype fixes for JSON and YAML files.

Built HTML and checked the output.

Summary
Add draft release notes for Review Board 5.0.2
Description From Last Updated

I haven't landed the URI templates change yet, but this is an important one that will require some explanation and …

chipx86chipx86

We'll need to document the Djblets version bump as part of this in Packaging (that release will also require some …

chipx86chipx86

This one was already added in 5.0.1.

maubinmaubin

This should use console, to get the newer styling.

chipx86chipx86

This can use :guilabel: for the label text.

chipx86chipx86

The text doesn't really tell the users how it impacted them. Let's add on "..., showing the wrong text and …

chipx86chipx86

I feel like "bug views" (and "infobox and redirect" (without further clarification)) assumes some knowledge readers likely won't have. Let's …

chipx86chipx86

We can probably clarify this just a tad. Instead of "text-type reviewables," we can say "were not able to be …

chipx86chipx86

Extra blank line here.

chipx86chipx86
maubin
  1. I do have this change from a while ago that I never landed, it's for improving the token expiration controls from the API tokens config page. I think it's ready to go, should we try to get it in for 5.0.2 or save it for a different release?

    1. Given the size of that I think sneaking it in just prior to release is maybe not wise. Let's get it landed right after we ship and test it a bit.

  2. docs/releasenotes/5.0.2.rst (Diff revision 1)
     
     
     
     
     

    This one was already added in 5.0.1.

    1. It looks like not. It had been pushed to release-4.0.x but that wasn't merged to release-5.0.x until after the 5.0.1 release.

    2. Ah yeah it looks like that because I had made a separate commit and review request for fixing the bug in 4.0.x and 5.0.x. This is the commit that contained the bug fix for 5.0.x. It was actually added in 5.0, not 5.0.1.

    3. Ah, I see.

  3. 
      
david
chipx86
  1. 
      
  2. docs/releasenotes/5.0.2.rst (Diff revision 2)
     
     

    This should use console, to get the newer styling.

  3. docs/releasenotes/5.0.2.rst (Diff revision 2)
     
     

    This can use :guilabel: for the label text.

  4. docs/releasenotes/5.0.2.rst (Diff revision 2)
     
     
     

    The text doesn't really tell the users how it impacted them. Let's add on "..., showing the wrong text and making it hard to determine if clicking the button would show or hide extra whitespace."

  5. docs/releasenotes/5.0.2.rst (Diff revision 2)
     
     

    I feel like "bug views" (and "infobox and redirect" (without further clarification)) assumes some knowledge readers likely won't have.

    Let's maybe refer to these as "internal URLs used to serve up information on bug/ticket IDs".

  6. docs/releasenotes/5.0.2.rst (Diff revision 2)
     
     
     
     
     

    We can probably clarify this just a tad. Instead of "text-type reviewables," we can say "were not able to be reviewed as normal text files, instead only allowing users to download them or leave a comment on the file as a whole."

  7. docs/releasenotes/5.0.2.rst (Diff revision 2)
     
     
     

    Extra blank line here.

  8. 
      
chipx86
  1. 
      
  2. I haven't landed the URI templates change yet, but this is an important one that will require some explanation and pointing to the root resource page for details.

    1. If there's any content in particular you'd like for that, please let me know.

  3. We'll need to document the Djblets version bump as part of this in Packaging (that release will also require some release notes).

    1. Are we calling that 3.2? Did you want me to write relnotes for that too?

  4. 
      
maubin
  1. 
      
  2. Rel notes for the token expiration change (feel free to change as you wish):
    The settings for API Token expirations in the My Account page have been improved. In addition to setting the date, you can now set the specific expiration time of tokens. It is also possible to edit the expiration of already expired tokens, and to set the expiration to a past date and time.

  3. 
      
chipx86
chipx86
Review request changed

Change Summary:

Added the remaining changes for 5.0.2.

Summary:

-Add draft release notes for Review Board 5.0.2.
+Add draft release notes for Review Board 5.0.2

Description:

~  

This change adds the release notes for the upcoming 5.0.2 bugfix release.

  ~

This change adds the release notes for the upcoming 5.0.2 release. This

  + provides a mix of new features and bug fixes.

  +
  +

Some notable new features include Trojan Source detection settings, API

  + token time-based expiration, enabling ACL support for diffs for
  + extensions, and reworked URI templates.

  +
  +

There are also fixes in the diff viewer, crashes fixes for upgrades, and

  + mimetype fixes for JSON and YAML files.

Commits:

Summary Author
-
Add draft release notes for Review Board 5.0.2.
David Trowbridge
+
Add draft release notes for Review Board 5.0.2
Christian Hammond

Diff:

Revision 3 (+298)

Show changes

Checks run (2 succeeded)

flake8 passed.
JSHint passed.
maubin
  1. Ship It!
  2. 
      
Loading...