Contributor and Reviewer Workflow
The process for contributing or reviewing a patch is documented in the Contributing to BookKeeper page.
Merge patches attached to JIRA
Create a branch to work on:
git checkout -b xyz remotes/origin/master
- Download the patch
git apply BOOKKEEPER-XXXX.patch
- Make sure unit tests pass
- Push the change back to Apache. You should almost always collapse your work into a single check-in in order to avoid cluttering the upstream change-log:
# assuming master is up-to-date with origin
git checkout master
git merge --squash xyz
git commit -am
"firstname lastname <contributoremail>"
git push origin master
Merge GitHub pull requests
All the GitHub pull requests could be merged and closed via bk-merge-pr.py.
bk-merge-pr.py is a script that automates the process of accepting a code change into the project. It creates a temporary branch from
apache/master, squashes the commits in the pull request, rewrites the commit message in the squashed commit to follow a standard format including information about each original commit, merges the squashed commit into the temporary branch, pushes the code to
apache/master and closes the JIRA ticket. The push will then be mirrored to
apache-github/master, which will cause the PR to be closed due to the pattern in the commit message. Note that the script will ask the user before executing remote updates (ie git push and closing JIRA ticket), so it can still be used even if the user wants to skip those steps.
1. Add aliases for the remotes expected by the merge script (if you haven't already):
2. Install jira-python:
sudo easy_install jira
Once the pull request is ready to be merged (it has been reviewed, feedback has been addressed, CI build has been successful and the branch merges cleanly into master):
1. Set the
JIRA_PASSWORD environment variables with the appropriate credentials if you intend to ask the script to close the issue associated with the pull request.
2. Run the merge script:
3. Answer the questions prompted by the script.