From Fedora Project Wiki
(ReviewBoard 2.0)
 
mNo edit summary
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<!-- Self Contained or System Wide Change Proposal?
<!-- Self Contained or System Wide Change Proposal?
Use this guide to determine to which category your proposed change belongs to.
Use this guide to determine to which category your proposed change belongs to.
Line 22: Line 20:
<!-- The actual name of your proposed change page should look something like: Changes/Your_Change_Proposal_Name.  This keeps all change proposals in the same namespace -->
<!-- The actual name of your proposed change page should look something like: Changes/Your_Change_Proposal_Name.  This keeps all change proposals in the same namespace -->


= Change Proposal Name <!-- The name of your change proposal --> =
= Review Board 2.0 <!-- The name of your change proposal --> =
Review Board 2.0


== Summary ==
== Summary ==
Line 38: Line 35:
<!-- Include you email address that you can be reached should people want to contact you about helping with your change, status is requested, or technical issues need to be resolved. If the change proposal is owned by a SIG, please also add a primary contact person. -->
<!-- Include you email address that you can be reached should people want to contact you about helping with your change, status is requested, or technical issues need to be resolved. If the change proposal is owned by a SIG, please also add a primary contact person. -->
* Email: sgallagh@redhat.com
* Email: sgallagh@redhat.com
* Release notes owner: <!--- To be assigned by docs team [[User:FASAccountName| Release notes owner name]] <email address> -->
* Release notes owner: [[User:Pbokoc| Petr Bokoc]] pbokoc at redhat dot com
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
Line 49: Line 46:
== Current status ==
== Current status ==
* Targeted release: [[Releases/21 | Fedora 21 ]]  
* Targeted release: [[Releases/21 | Fedora 21 ]]  
* Last updated: (2014-05-09)
* Last updated: 2014-05-21 (Packages are now all in Fedora)
<!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page  
<!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page  
Bugzilla states meaning as usual:
Bugzilla states meaning as usual:
Line 58: Line 55:
CLOSED as NEXTRELEASE -> change is completed and verified and will be delivered in next release under development
CLOSED as NEXTRELEASE -> change is completed and verified and will be delivered in next release under development
-->
-->
* Tracker bug: <will be assigned by the Wrangler>
* Tracker bug: [https://bugzilla.redhat.com/show_bug.cgi?id=1104674 #1104674]


== Detailed Description ==
== Detailed Description ==
Line 64: Line 61:
Review Board integrates with many types of repository (svn, git, mercurial, perforce and more) as well as popular hosting environments such as Fedora Hosted, Github and Bitbucket. It provides a powerful and clean interface to managing patches for review.
Review Board integrates with many types of repository (svn, git, mercurial, perforce and more) as well as popular hosting environments such as Fedora Hosted, Github and Bitbucket. It provides a powerful and clean interface to managing patches for review.


Review Board 2.0 adds a more comprehensive public API as well as support for extensions and hooks, as well as significant performance improvements and visual cleanups.
Review Board 2.0 adds the ability to post committed changes from a branch directly from the web UI, adds review of text file attachments, greatly extends the capabilities of the public API and extension framework, and offers significant performance improvements, usability enhancements, and visual cleanups.


== Benefit to Fedora ==
== Benefit to Fedora ==
Line 87: Line 84:


Existing Fedora users who were running Review Board 1.x will be automatically upgraded to ReviewBoard 2.0. The upgrade process will automatically migrate their database schema the first time Apache is started after the RPM upgrade. This upgrade ''does'' permanently alter the database, making downgrade unsafe. The Release Notes should recommend backing up their database before upgrading this package.  
Existing Fedora users who were running Review Board 1.x will be automatically upgraded to ReviewBoard 2.0. The upgrade process will automatically migrate their database schema the first time Apache is started after the RPM upgrade. This upgrade ''does'' permanently alter the database, making downgrade unsafe. The Release Notes should recommend backing up their database before upgrading this package.  


== How To Test ==
== How To Test ==
Line 126: Line 122:


<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
N/A (not a System Wide Change)  
N/A (not a System Wide Change)
 
== Contingency Plan ==
== Contingency Plan ==
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages).  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages).  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
* Contingency mechanism: Review Board is a leaf package affecting no other part of the system. If Review Board is not ready in time (unlikely; upstream indicates a final release to be coming within the month), we will likely release Fedora 21 with a release candidate and update it to a stable release later.  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Contingency mechanism: Review Board is a leaf package affecting no other part of the system. If Review Board is not ready in time (unlikely; upstream indicates a final release to be coming within the month), we will likely release Fedora 21 with a release candidate and update it to a stable release later.  Update 2014-05-21: All Review Board 2.0 packages have landed in Rawhide. This Change is effectively complete. <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->


<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
Line 143: Line 139:
* http://www.reviewboard.org/docs/manual/dev/ (During pre-release phase)
* http://www.reviewboard.org/docs/manual/dev/ (During pre-release phase)
* http://www.reviewboard.org/docs/manual/2.0/ (Once the release is out)
* http://www.reviewboard.org/docs/manual/2.0/ (Once the release is out)


== Release Notes ==
== Release Notes ==
Line 153: Line 148:


Fedora now provides Review Board 2.0, a powerful, web-based patch review and management tool.
Fedora now provides Review Board 2.0, a powerful, web-based patch review and management tool.
Review Board 2.0 adds the ability to post committed changes from a branch directly from the web UI, adds review of text file attachments, greatly extends the capabilities of the public API and extension framework, and offers significant performance improvements, usability enhancements, and visual cleanups.
Significant enhancements have been made to the diff viewer, as well as adding support for reviews on non-code files (such as binary file formats).


For users of previous versions of Review Board, please be aware that (as with minor releases) upgrading to Review Board 2.0 will modify your database schema and is a one-way process. Please back up your database before upgrading.
For users of previous versions of Review Board, please be aware that (as with minor releases) upgrading to Review Board 2.0 will modify your database schema and is a one-way process. Please back up your database before upgrading.


[[Category:ChangeReadyForWrangler]]
[[Category:ChangeAcceptedF21]]
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->

Latest revision as of 22:08, 11 August 2014


Review Board 2.0

Summary

Review Board is a powerful tool for managing patch reviews.

Owner

Current status

  • Targeted release: Fedora 21
  • Last updated: 2014-05-21 (Packages are now all in Fedora)
  • Tracker bug: #1104674

Detailed Description

Review Board integrates with many types of repository (svn, git, mercurial, perforce and more) as well as popular hosting environments such as Fedora Hosted, Github and Bitbucket. It provides a powerful and clean interface to managing patches for review.

Review Board 2.0 adds the ability to post committed changes from a branch directly from the web UI, adds review of text file attachments, greatly extends the capabilities of the public API and extension framework, and offers significant performance improvements, usability enhancements, and visual cleanups.

Benefit to Fedora

Fedora will benefit from having the latest version of Review Board available for deployment. Review Board on Fedora is one of the fastest ways for a user or company to stand up a maintainable Review Board infrastructure without worrying about managing interaction with PyPI.

Scope

  • Proposal owners: Review Board 2.0 RC3 is in Rawhide today and will be upgraded to 2.0 final when it is released (expected by the end of May, 2014)
  • Other developers: N/A (not a System Wide Change)
  • Release engineering: N/A (not a System Wide Change)
  • Policies and guidelines: N/A (not a System Wide Change)

Upgrade/compatibility impact

Existing Fedora users who were running Review Board 1.x will be automatically upgraded to ReviewBoard 2.0. The upgrade process will automatically migrate their database schema the first time Apache is started after the RPM upgrade. This upgrade does permanently alter the database, making downgrade unsafe. The Release Notes should recommend backing up their database before upgrading this package.

How To Test

  1. Deploy a new Review Board site using /usr/bin/rb-site install
  2. Log into the new site using a web browser.
  3. Set up one or more repositories in the admin UI.
  4. Create one or more patch reviews using the web UI.
  5. Create one or more patch reviews using the RBTools (with 'rbt post')

User Experience

New users:

  • They will have access to a powerful tool for managing and reviewing patches (and multiple revisions of those patches)

Existing users of 1.x:

  • The interface is cleaner and faster, with more filtering and extension options.
  • Newer versions of RBTools will allow greater capabilities, particularly when operating with Git, Subversion and Clearcase repositories.

Dependencies

N/A (not a System Wide Change)

Contingency Plan

  • Contingency mechanism: Review Board is a leaf package affecting no other part of the system. If Review Board is not ready in time (unlikely; upstream indicates a final release to be coming within the month), we will likely release Fedora 21 with a release candidate and update it to a stable release later. Update 2014-05-21: All Review Board 2.0 packages have landed in Rawhide. This Change is effectively complete.
  • Contingency deadline: N/A (not a System Wide Change)
  • Blocks release? No
  • Blocks product? No

Documentation

Release Notes

Fedora now provides Review Board 2.0, a powerful, web-based patch review and management tool.

Review Board 2.0 adds the ability to post committed changes from a branch directly from the web UI, adds review of text file attachments, greatly extends the capabilities of the public API and extension framework, and offers significant performance improvements, usability enhancements, and visual cleanups.

Significant enhancements have been made to the diff viewer, as well as adding support for reviews on non-code files (such as binary file formats).

For users of previous versions of Review Board, please be aware that (as with minor releases) upgrading to Review Board 2.0 will modify your database schema and is a one-way process. Please back up your database before upgrading.