Page History

...

1. Follow instructions here to setup the jira-python package
2. Follow instructions here to setup the reviewboard python tools
3. Install the argparse module

   Code Block
   On Linux -> sudo yum install python-argparse On Mac -> sudo easy_install argparse

4. Download the kafka reviewboard script here and place it in the location of your git checkout. Once KAFKA-1053 is resolved, this step will be unnecessary

2. Usage

nnarkhed-mn:kafka-git-idea nnarkhed$ python kafka-patch-review.py --help
usage: kafka-patch-review.py [-h] -b BRANCH -j JIRA [-s SUMMARY]
                             [-d DESCRIPTION] [-r REVIEWBOARD] [-t TESTING]
                             [-v VERSION] [-db]

Kafka patch review tool

optional arguments:
  -h, --help            show this help message and exit
  -b BRANCH, --branch BRANCH
                        Tracking branch to create diff against
  -j JIRA, --jira JIRA  JIRA corresponding to the reviewboard
  -s SUMMARY, --summary SUMMARY
                        Summary for the reviewboard
  -d DESCRIPTION, --description DESCRIPTION
                        Description for reviewboard
  -r REVIEWBOARD, --rb REVIEWBOARD
                        Review board that needs to be updated
  -t TESTING, --testing-done TESTING
                        Text for the Testing Done section of the reviewboard
  -v VERSION, --version VERSION
                        Version of the patch
  -db, --debug          Enable debug mode

...

1. Specify the branch against which the patch should be created (-b)
2. Specify the corresponding JIRA (-j)
3. Specify an optional summary (-s) and description (-d) for the reviewboard

Example:

 python kafka-patch-review.py -b origin/trunk -j KAFKA-42 

4. Update patch

1. Specify the branch against which the patch should be created (-b)
2. Specify the corresponding JIRA (--jira)
3. Specify the rb to be updated (-r)
4. Specify an optional summary (-s) and description (-d) for the reviewboard, if you want to update it
5. Specify an optional version of the patch. This will be appended to the jira to create a file named JIRA-<version>.patch. The purpose is to be able to upload multiple patches to the JIRA. This has no bearing on the reviewboard update.

...