O'Reilly logo

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Getting Started with Review Board

Book Description

A complete tour of all the great features of Review Board, from creating a review request to managing Review Board as an administrator. Whether you're in development or quality control, this guide could change your working life.

In Detail

How would you feel if the world's craftiest programmer went through every line of code that you wrote before it appeared on the user's screen? Everyone is not lucky enough to have a person to go through their code! Reviewboard is a powerful web-based code review tool that offers developers an easy way to handle code reviews. It scales well from small projects to large companies and offers a variety of tools to take much of the stress and time out of the code review process.

Based on the philosophy that "Merely using a tool is one thing, using it right is another", Getting Started with Review Board will guide you on a journey to mastering Reviewboard by teaching you how to publish a code review request through the Reviewboard web UI or command line. It will help you become an ace Reviewboard administrator as you'll learn how to manage users, review groups, default reviewers, repositories, and much more.

This practical, example-oriented book covers the code review workflow in detail. It also talks about the various features in Reviewboard which make your life a lot easier as a code author, reviewer, and administrator.

You will start the journey by looking at the different ways of sharing the code changes (diff) with your team which will also cover integration with a repository. Then, you will look at how a code review can be performed and how you can provide your input on the code changes or on the whole diff. You will also look at the user dashboard, which provides an overview of the review requests and user/group activities which the user is a part of. Finally the administration of Reviewboard application and admin dashboard will be explored. You will end the book by learning advanced tips and tricks to get the best out of Reviewboard.

What You Will Learn

  • Install and set up Reviewboard
  • Create a review request with the changes you have introduced
  • Publish or share the review request with the team/reviewer/reviewer groups
  • Integrate your code with code repositories
  • Close the code review request by providing a review comment
  • Understand how to search the user dashboard (limited and full text search)
  • Manage Reviewboard as an administrator
  • Acquire tips and tricks to optimize the usage and performance of Reviewboard

Table of Contents

  1. Getting Started with Review Board
    1. Table of Contents
    2. Getting Started with Review Board
    3. Credits
    4. About the Author
    5. About the Reviewers
    6. www.PacktPub.com
      1. Support files, eBooks, discount offers, and more
        1. Why subscribe?
        2. Free access for Packt account holders
    7. Preface
      1. What this book covers
      2. What you need for this book
      3. Who this book is for
      4. Conventions
      5. Reader feedback
      6. Customer support
      7. Downloading the color images of this book
        1. Errata
        2. Piracy
        3. Questions
    8. 1. Introduction to Review Board
      1. Code review – power-charging your code
      2. Code review best practices
      3. Ways of performing code review
        1. Pre-commit code review
        2. Post-commit code review
      4. Why Review Board?
      5. What people are saying about Review Board
      6. Features of Review Board
        1. Publishing
        2. Easy code review
        4. Intuitive diff viewer
        5. Great tracking
        6. Integration with all major version control systems
        7. Not limited to code files
        8. Admin control
      7. Summary
    9. 2. Creating Review Requests
      1. Publishing a code review request
        1. Generating a code diff
        2. Publishing the generated code diff to Review Board
      2. Publishing a review request with details
      3. Tracking review requests
        1. Publishing a code review request through the command line
          1. Pre-commit review
          2. Post-commit review
          3. Review of specific files
          4. Updating a code review request
      4. Summary
    10. 3. Reviewing Code Review Requests
      1. Viewing a review request
      2. Viewing the code review requests
      3. Performing the code review
        1. Managing issues
      4. Summary
    11. 4. The User Dashboard, Preferences, and Searching
      1. The user dashboard
        1. Incoming Reviews
        2. Outgoing Reviews
        3. Starred Reviews
        4. All My Requests
        5. Table columns
      2. Preferences / My Account
      3. Searching
        1. Quick search
        2. Full-text search
      4. Summary
    12. 5. Installing and Upgrading Review Board
      1. Setting up Review Board
        1. Review Board installation
          1. Steps 1 and 2 – installing the Python setuptools
          2. Step 3 – installing Patch
          3. Step 4 – installing Review Board
          4. Step 5 – installing MySQL database binding
          5. Step 6 – the subversion source control component
        2. Installing the Review Board site
        3. Updating Apache config
      2. Upgrading Review Board
      3. Summary
    13. 6. Admin Settings
        1. General
        2. Authentication
        3. E-mail
        4. Diff Viewer
        5. Logging
        6. SSH
        7. File Storage
      3. Summary
    14. 7. Managing Users and Review Groups
      1. Users
      2. Review Groups
      3. Summary
    15. 8. Admin Dashboard
      1. Repository administration
      2. Activities
        2. USER ACTIVITY
        7. REVIEW GROUPS
      3. Summary
    16. 9. Advanced Tips and Tricks
      1. Database
      2. Extensions
      3. Optimization
        1. Hardware
        2. Memcached
        3. Database
      4. Search indexing
      5. Advanced commands
      6. Summary
    17. Index