Summary

Add draft release notes for RBTools 3.0.

Review Request #12134 — Created March 10, 2022 and submitted March 21, 2022, 9:43 p.m.

Information

Owner

david

Repository

RBTools

Branch

master

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

This change adds release notes for the new features and improvements
that will ship as RBTools 3.0.

Testing Done

Built HTML and checked output.

Commits

Summary	ID
Add draft release notes for RBTools 3.0. This change adds release notes for the new features and improvements that will ship as RBTools 3.0. Testing Done: Built HTML and checked output.	a8de8227369ca750663d6535c2f2a0d995723d1b

Issues

Description	From	Last Updated
Some missing changes: More detail on the repository architectural changes and command changes (3fbea5f, 37728c4, a98f021, 53b7208, 35275e6) for people …	chipx86	March 17, 2022, 1:03 p.m.
Things look good for the most part, but the "Other Improvements" section feels a bit disorganized. Some entries are new …	chipx86	March 18, 2022, 4:53 p.m.
Typo: "Fetaures" -> "Features"	chipx86	March 16, 2022, 10:03 p.m.
We should specify the minimum version of Review Board required for this (I recommend we just say 4.0.6, given the …	chipx86	March 17, 2022, 12:30 p.m.
Rather than "a new backend," let's say "new repository support" Also, rather than the "... more powerful", maybe we could …	chipx86	March 16, 2022, 10:05 p.m.
"new new" support! :)	chipx86	March 18, 2022, 4:51 p.m.
The backticks aren't needed in the definitions.	chipx86	March 16, 2022, 10:05 p.m.
Let's sell this better. Can we talk about the capabilities this provides?	chipx86	March 16, 2022, 10:06 p.m.
We don't document any of these right now, do we? We should probably have tasks for that.	chipx86	March 17, 2022, 12:30 p.m.
Missing a period.	chipx86	March 16, 2022, 10:06 p.m.
Mind double-checking that they're all in AUTHORS?	chipx86	March 16, 2022, 10:07 p.m.

flake8 passed.

JSHint passed.

The issue has been resolved. Show all issues

Some missing changes:

More detail on the repository architectural changes and command changes (3fbea5f, 37728c4, a98f021, 53b7208, 35275e6) for people building on top of RBTools.
Deprecation of TREES (7c0b6b0)

(The following are in release-2.0.x, but aren't released.)

Fixes to the default User-Agent value sent in API requests (5558459 — Lukasz Kawczynski)
Custom commands and aliases now show up in --help (b9e4c9b — Matthew Blythe)
Fixes for excluded/included files affecting full Git diffs (97d6a9a — Andrej Radovi?)

docs/releasenotes/3.0.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Typo: "Fetaures" -> "Features"
```

docs/releasenotes/3.0.rst (Diff revision 1)

The issue has been dropped. Show all issues

We should specify the minimum version of Review Board required for this (I recommend we just say 4.0.6, given the new diff functionality was added in 4.0.5 and things fixed up in 4.0.6).

david March 17, 2022, 1:03 p.m.

That seems more appropriate for the Power Pack release notes. This is RBTools.

docs/releasenotes/3.0.rst (Diff revision 1)

The issue has been resolved. Show all issues

Rather than "a new backend," let's say "new repository support"

Also, rather than the "... more powerful", maybe we could say something like:

"... HCL VersionVault and IBM ClearCase, built in cooperation with HCL. This replaces the old community-driven ClearCase implementation in Review Board, offering better compatibility, official support, and modern functionality. It includes ..."

docs/releasenotes/3.0.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
The backticks aren't needed in the definitions.
```

docs/releasenotes/3.0.rst (Diff revision 1)

The issue has been resolved. Show all issues

Let's sell this better. Can we talk about the capabilities this provides?

docs/releasenotes/3.0.rst (Diff revision 1)

The issue has been dropped. Show all issues

We don't document any of these right now, do we? We should probably have tasks for that.

david March 17, 2022, 1:03 p.m.
```
Not right now.
```

docs/releasenotes/3.0.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Missing a period.
```
docs/releasenotes/3.0.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Mind double-checking that they're all in AUTHORS?
```

Commits:

	Summary	ID
	Add draft release notes for RBTools 3.0. This change adds release notes for the new features and improvements that will ship as RBTools 3.0. Testing Done: Built HTML and checked output.	d471638fadacfec839760a5963955008df261fb6
	Add draft release notes for RBTools 3.0. This change adds release notes for the new features and improvements that will ship as RBTools 3.0. Testing Done: Built HTML and checked output.	5746303868fe62f0e6b5b3e4788416699e92bc1b

Diff:

Revision 2 (+284)

Show changes

	AUTHORS
	docs/releasenotes/3.0.rst
	docs/releasenotes/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

The issue has been resolved. Show all issues

Things look good for the most part, but the "Other Improvements" section feels a bit disorganized. Some entries are new features, some deprecations, some bug fixes. I think we can clean this up by just moving the bug fixes into a "Bug Fixes" section, like other release notes have.

docs/releasenotes/3.0.rst (Diff revisions 1 - 2)
The issue has been resolved. Show all issues
```
"new new" support! :)
```

Commits:

	Summary	ID
	Add draft release notes for RBTools 3.0. This change adds release notes for the new features and improvements that will ship as RBTools 3.0. Testing Done: Built HTML and checked output.	5746303868fe62f0e6b5b3e4788416699e92bc1b
	Add draft release notes for RBTools 3.0. This change adds release notes for the new features and improvements that will ship as RBTools 3.0. Testing Done: Built HTML and checked output.	a8de8227369ca750663d6535c2f2a0d995723d1b

Diff:

Revision 3 (+292)

Show changes

	AUTHORS
	docs/releasenotes/3.0.rst
	docs/releasenotes/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-3.x (656f0c1)