RBTools 5.0 Release Notes¶

Binary Files in Diffs¶

Review Board 7.0 is introducing the ability to include binary files in the diff viewer, starting with images. RBTools 5.0 is necessary to use this feature, to upload the data for any binary files which are part of your change.

This is enabled for select version control systems:

• Git

• Mercurial

• Perforce

• Subversion

If you are using a different version control system, and would like support added for it, please contact us to request it.

Authentication Improvements¶

• Web-based login.

  The new option --web will allow users to authenticate RBTools to their Review Board server by logging in via a web page. Using this along with --open will automatically open the page in the browser.

  This is particularly useful in the case where users are authenticating with Single Sign-On, and do not have a specific password to use for Review Board.

  You may set WEB_LOGIN = True in .reviewboardrc to always prefer web-based login.

  Note

  Web-based login only works when rbt is running on the local system. If you are logged in to another host via SSH, you will need to use a username/password or API token.

• Log in with an API token.

  The new option --api-token allows logging in with an API token passed on the command line. This is extra handy for writing automations with RBTools, since it does not require creating a .reviewboardrc file to store the API token.

• Added better error messages when trying to log in with an expired or invalid API token.

rbt review¶

• JSON output mode has been added for the rbt review command.

  The output contains information relevant to the review, such as:

  • The review ID.

  • The review API URL.

  • The review URL.

  • The review status, which can be draft, published, or discarded.

  • The review request ID.

  • The review request URL.

  When a comment subcommand is used, the following comment details are also included in the output:

  • The comment type, which can be diff_comment, file_attachment_comment, or general_comment.

  • The comment ID.

  • The comment API URL.

• Fixed a bug where rbt review add-diff-comment would always add the comment to the last file in the diffset, instead of the specified file.

rbt patch¶

• Added the ability for rbt patch to download and apply draft patches which have not yet been published.

  Only the owner of a review request, or a special user with the can_edit_review_request permission can fetch draft diffs.

rbt setup-completion¶

• Updated rbt setup-completion to print out the completion settings to the terminal, rather than attempting to write them to the user’s configuration.

  Determining the correct place to put auto-completion information for a user’s shell is extremely difficult, and the prior implementation often got things wrong on Windows and macOS. This command will now print out the relevant configuration lines, allowing the user to integrate it within their own shell configuration as they see fit.

Deprecated Code Removal¶

The following APIs have been removed:

• The find_server_repository_info() method has been removed from BaseSCMClient subclasses.

• The rbtools.utils.match_score module has been removed.

• The repository_info and repository_name arguments to find_review_request_by_change_id() have been removed.

• The repository_info, repository_name, guess_summary, and guess_description arguments to guess_existing_review_request() have been removed. The submit_as argument is now required.

• The require_repository_info argument to BaseCommand.initialize_scm_tool() has been removed.

• The urlopen parameter to APICache.__init__() has been removed.

• ResourceDictField.iterfields() and ResourceDictField.iteritems() have been removed.

• rbtools.clients.SCMClient has been renamed to rbtools.clients.base.scmclient.BaseSCMClient.

• BaseSCMClient.scmclient_id is now always required.

• BaseCommand.setup_tool() has been removed.

• BaseCommand.get_server_url() has been removed.

• BaseSCMClient.entrypoint_name has been removed.

• rbtools.utils.checks.check_gnu_diff() has been removed.

• rbtools.utils.checks.is_valid_version() has been removed.

• rbtools.utils.filesystem.CONFIG_FILE has been removed.

• rbtools.utils.process.log_command_line() has been removed.

• rbtools.utils.review_request.get_possible_matches() has been removed.

• rbtools.utils.review_request.num_exact_matches() has been removed.

The following APIs now require keyword-only arguments and will raise an error if called with positional arguments:

• BaseSCMClient.amend_commit_description()

• BaseSCMClient.apply_patch()

• BaseSCMClient.apply_patch_for_empty_files()

• BaseSCMClient.create_commit()

• BaseSCMClient.delete_branch()

• BaseSCMClient.diff()

• BaseSCMClient.get_tree_matches_review_request()

• BaseSCMClient.merge()

• RepositoryInfo.__init__()

• rbtools.utils.diffs.filename_match_any_patterns()

• rbtools.utils.diffs.filter_diff()

• rbtools.utils.diffs.normalize_patterns()

• rbtools.utils.diffs.remove_filenames_matching_patterns()

• rbtools.utils.filesystem.make_tempfile()

New Deprecations¶

• Deprecated rbtools.utils.process.execute().

  New code should use rbtools.utils.process.run_process() instead.

• The api_client argument to rbtools.utils.review_request.guess_existing_review_request() has been deprecated.

• The following APIs now require keyword-only arguments and will warn if called with positional arguments:

  • rbtools.utils.review_request.find_review_request_by_change_id()

  • rbtools.utils.review_request.guess_existing_review_request()