Versions Compared

Old Version 19

changes.mady.by.user Neha Narkhede

Saved on

compared with

New Version 20

changes.mady.by.user Neha Narkhede

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Kafka JIRA and Reviewboard script

1. Setup

  1. Follow instructions here to setup the jira-python package
  2. Follow instructions here to setup the reviewboard python tools
  3. 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

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. Specify the branch against which the patch should be created (-b)
  2. Specify the corresponding JIRA (-j)
  3. Specify an optional summary (-s) and (-d) for the reviewboard

Example:

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.

Example:

Code Block
python kafka-rb.py -b origin/trunk -j KAFKA-42 -r 14081 -s "update summary" -d "update description" --version v2

JIRA command line tool

1. Download the JIRA command line package

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.

1. Install the post-review tool

Follow the instructions here to setup the post-review tool.

2. Configure Stuff

Then you need to configure a few things to make it work:

First set the review board url to use. You can do this from in git:

Code Block
git config reviewboard.url https://reviews.apache.org

If you checked out using the git wip http url that confusingly won't work with review board. So you need to configure an override to use the non-http url. You can do this by adding a config file like this:

Code Block
jkreps$ cat ~/.reviewboardrc
REPOSITORY = 'git://git.apache.org/kafka.git'