Welcome to github-reviewboard-sync’s documentation!

Contents:

github-reviewboard-sync

Documentation Status

Syncs pull requests with ReviewBoard submissions allowing you to create a pull request and review board submission at the same time

Overview

This tool allows you to easily create a pull request and reviewboard submission at the same time

grs open my-feature-branch --github-username=MyUsername

You can also simply provide an environment variable GITHUB_USERNAME instead of passing in your github username. To add it to your bash profile simply run the following

echo 'export GITHUB_USERNAME=MyUsername' >> ~/.bash_profile

If you want to compare against a different branch and open a pull request to that branch

grs open my-feature-branch --base=version-branch

If you want to update an existing review board submission

grs open my-feature-branch -u

Installation

pip install github-reviewboard-sync

Or if you prefer

easy_install github-reviewboard-sync

Features

  • Opens a pull request on github with a sane name and message based on commits
  • Opens/updates a submission on review board with a sane summary and description based on commits
  • Adds github pull request url to review board submission and vice versa

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Indices and tables