• Get Review Board
  • What's New
  • Products
  • Review Board Code review, image review, and document review
  • Documentation
  • Release Notes
  • Power Pack Enterprise integrations, reports, and enhanced document review
  • Try for 60 Days
  • Purchase
  • RBCommons Review Board as a Service, hosted by us
  • Pricing
  • RBTools Command line tools and Python API for Review Board
  • Documentation
  • Release Notes
  • Review Bot Automated code review, connecting tools you already use
  • Documentation
  • Release Notes
  • RB Gateway Manage Git and Mercurial repositories in your network
  • Documentation
  • Release Notes
  • Learn and Explore
  • What is Code Review?
  • Documentation
  • Frequently Asked Questions
  • Support Options
  • Third-Party Integrations
  • Demo
  • Review Board RBTools Power Pack Review Bot Djblets RB Gateway
    1. Review Bot 4.x
    2. Version 4.x
    3. Version 3.0
    4. Version 2.0
    5. Version 1.0
    6. Upgrading Review Bot
  • Home
  • Installation
  • Manually Installing Review Bot
  • Review Bot Docker Images
  • Upgrading Review Bot
  • Configuring Review Bot
  • Review Bot Tools
  • Cargo Tool
  • Checkstyle
  • Clang Static Analyzer
  • Cppcheck
  • Cpplint
  • Doc8
  • FBInfer
  • Flake8
  • Go Fmt
  • Go Tool
  • JSHint
  • PMD
  • Pycodestyle
  • Pydocstyle
  • Pyflakes
  • RuboCop
  • Rust Fmt
  • Secret Scanner
  • ShellCheck
  • Module and Class Reference
  • reviewbot.tools.base
  • reviewbot.tools.base.mixins
  • reviewbot.tools.base.registry
  • reviewbot.tools.base.tool
  • reviewbot.testing.testcases
  • reviewbot.testing.utils
  • reviewbot.tools.testing
  • reviewbot.tools.testing.decorators
  • reviewbot.tools.testing.testcases
  • reviewbot.processing.review
  • reviewbot.utils.api
  • reviewbot.utils.filesystem
  • reviewbot.utils.log
  • reviewbot.utils.process
  • reviewbot.utils.text
  • reviewbot.celery
  • reviewbot.config
  • reviewbot.deprecation
  • reviewbot.errors
  • reviewbot.repositories
  • reviewbot.tasks
  • reviewbot.tools.cargotool
  • reviewbot.tools.checkstyle
  • reviewbot.tools.clang
  • reviewbot.tools.cppcheck
  • reviewbot.tools.cpplint
  • reviewbot.tools.doc8
  • reviewbot.tools.fbinfer
  • reviewbot.tools.flake8
  • reviewbot.tools.gofmt
  • reviewbot.tools.gotool
  • reviewbot.tools.jshint
  • reviewbot.tools.pmd
  • reviewbot.tools.pycodestyle
  • reviewbot.tools.pydocstyle
  • reviewbot.tools.pyflakes
  • reviewbot.tools.rbsecretscanner
  • reviewbot.tools.rubocop
  • reviewbot.tools.rustfmt
  • reviewbot.tools.shellcheck
  • General Index
  • Python Module Index
  • Release Notes
  • Upgrading Review Bot¶

    Upgrading Review Bot Packages¶

    From Review Bot 1.0 or Newer¶

    Upgrading Review Bot is easy. You’ll just need to upgrade the extension, workers, and then make any necessary configuration changes.

    Upgrade the Extension¶

    To start, upgrade the extension on the Review Board server:

    $ sudo pip install -U reviewbot-extension
    

    Depending on your configuration, you may need to restart or reload your web server. The specific command depends on your individual setup, but is usually something like the following:

    $ sudo service httpd reload
    

    Open the Review Board administration page and click Extensions. You should see the new version of Review Bot installed.

    Upgrade the Workers¶

    You can now upgrade each worker.

    If you have a manual installation, run:

    $ sudo pip install -U reviewbot-worker
    

    (If you’re installing in a virtual environment, don’t use sudo.)

    Then follow the Upgrading Review Bot Configuration for any configuration changes you may need to make.

    If you’re using our official Docker images, you can just switch to a newer tag and restart your containers.

    From Review Bot 0.1 or 0.2¶

    The configuration of Review Bot 0.1 and 0.2 worked differently than modern versions, so to start, make a note of all your settings.

    Then you’ll need to uninstall the old extension on the Review Board server:

    $ sudo pip uninstall Review_Bot_Extension
    

    And then uninstall each worker:

    $ sudo pip uninstall ReviewBot
    

    Then follow the installation instructions to install a modern version.

    Upgrading Review Bot Configuration¶

    Review Bot 3.0 Configuration Changes¶

    Deprecated Settings¶

    The following configuration settings have been deprecated:

    • checkstyle_path

      The .jar file should now be specified as an item in a list in java_classpaths, keyed off by checkstyle. For example:

      java_classpaths = {
          'checkstyle': [
              '/opt/checkstyle/checkstyle-X.Y.jar',
          ],
      }
      
    • pmd_path

      This should now be specified as pmd in exe_paths. For example:

      exe_paths = {
          'pmd': '/opt/pmd/bin/pmd',
      }
      
    • review_board_servers

      This has been renamed to reviewboard_servers.

    Deprecated settings will continue to work until Review Bot 4.0.

    Cookie Settings¶

    In prior releases, Review Board session cookies were stored in the current directory where Review Bot was run from. They’re now stored in a dedicated cache directory for the user Review Bot is running as.

    This path can be configured through the cookie_dir setting.

    See Cookie Storage for details.

    Keep up with the latest Review Board releases, security updates, and helpful information.

    About
    News
    Demo
    RBCommons Hosting
    Integrations
    Happy Users
    Support Options
    Documentation
    FAQ
    User Manual
    RBTools
    Administration Guide
    Power Pack
    Release Notes
    Downloads
    Review Board
    RBTools
    Djblets
    Power Pack
    Package Store
    PGP Signatures
    Contributing
    Bug Tracker
    Submit Patches
    Development Setup
    Wiki
    Follow Us
    Mailing Lists
    Reddit
    Twitter
    Mastodon
    Facebook
    YouTube

    Copyright © 2006-2025 Beanbag, Inc. All rights reserved.

    Terms of Service — Privacy Policy — AI Ethics Policy — Branding

    On this page

    • [Top]
    • Upgrading Review Bot Packages
      • From Review Bot 1.0 or Newer
        • Upgrade the Extension
        • Upgrade the Workers
      • From Review Bot 0.1 or 0.2
    • Upgrading Review Bot Configuration
      • Review Bot 3.0 Configuration Changes
        • Deprecated Settings
        • Cookie Settings