Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
nnarkhed-mn:kafka-git-idea nnarkhed$ python kafka-rb.py --help
usage: kafka-rb.py [-h] -b BRANCH -j JIRA [-s SUMMARY] [-d DESCRIPTION]
                   [-r REVIEWBOARD] [-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
  -v VERSION, --version VERSION
                        Version of the patch
  -db, --debug          Enable debug mode

3. Upload patch

  1. Ensure the patch review tool is in the directory where the git repository is checked out
  2. Specify the branch against which the patch should be created (-b)
  3. Specify the corresponding JIRA (-j)
  4. Specify an optional summary (-s) and (-d) for the reviewboard

...

Code Block
 python kafka-rb.py -b origin/trunk -j KAFKA-42 -s "test summary" -d "test description"

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 (-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.

...

1. Download the JIRA command line package

Follow instructions here to download the JIRA command line tool package

2. Customize the jira script

...

Install the jira-python package

Code Block

sudo easy_install jira-python

2. Configure JIRA username and password

Include a jira.ini file in your $HOME directory that contains your Apache JIRA username and password

Code Block

nnarkhed-mn:

...

~ nnarkhed$ cat ~/jira.

...

ini
user=nehanarkhede
password=***********

...


Reviewboard

This is a quick tutorial on using Review Board with Kafka.

...