Development Workflow

Development workflow

For code review I suggest Google review board. Currently located at https://fermicloud140.fnal.gov/reviews. Its advantage over GitHub review is that it is far more powerful.

Go to this site and register. Accessible from Fermilab network only. So need VPN for off-site access.

Install RBTools

yum install RBTools

Optionally (convenient if you work w/ the same repo all the time):

Edit ~/.reviweboardrc

echo "REPOSITORY = \"git://github.com/HEPCloud/decisionengine.git\"" > ~/.reviewboardrc

Edit ~/.gitconfig by adding:

[reviewboard]
        url = https://fermicloud140.fnal.gov/reviews

Suggested development cycle

Create a fork of the main github repo that you can work from. Then, clone that fork to your workspace:

 git clone https://github.com/<myusername>/decisionengine
 git pull
 git checkout -b <my branch>

Work on your branch.

Remember to periodically sync the main github repo (HEPCloud/decisionengine) with your copy of the repo. This can be done using pull requests in your fork on github (merge HEPCloud/decisionengine --> your fork) or locally from the command line:

git remote add upstream https://github.com/HEPCloud/decisionengine.git
git fetch upstream
git checkout master
git merge upstream/master

After any resyncing, rebase your branch on top of master.

git checkout <my branch>
git rebase master 

When ready to post, do

git commit -a 

Post patch for review:

rbt post --guess-description --summary="summary" --testing-done="how I tested" --disable-ssl-verification

If you do not wish to have pre-set default in ~/.reviewboardrc or ~/.gitconfig, then include repository on the command line:

rbt post -d --server=https://fermicloud140.fnal.gov/reviews/ --guess-description --summary="ModuleName: patch description"  --repository-url=git://github.com/HEPCloud/decisionengine.git --parent=upstream/master

The command will ask your username / password at reviewboard and will spit the URL of your review request, e.g. https://fermicloud140.fnal.gov/reviews/r/NUMBER/ . Cut&paste it into your browser. Finish review request by checking that diff looks good (upper right corner tabs). Fill in necessary additions to Description and Testing. Add Group name "decisionengine" under "Reviewers". If the changes are to fix an "Issue" in GitHub, add the issue number in the "Bug" link on the right side of the page. When you are finished click "Publish".

An e-mail be sent to members of "decisionengine" group, and someone will review the request. IF you need to modify your review. Commit the change locally and run:

 rbt post -r NUMBER   

or

rbt post -r NUMBER  --server=https://fermicloud140.fnal.gov/reviews/ --repository-url=git://github.com/HEPCloud/decisionengine.git --parent=upstream/master

This will post another diff to https://fermicloud140.fnal.gov/reviews/r/NUMBER. Visit the page furnish it with details of your new commit and click publish.

When review is approved.

git checkout master
git fetch upstream
git merge upstream/master
git checkout <my branch>
git rebase master
git checkout master 
git merge --squash <my branch>
git commit -a 

Above command normally opens commit message edit dialog. When writing commit message I suggest:

1. Remove all intermediate commit messages you might have made while developing your patch
2. Use concise statement to summarize patch.
3. Write details in the next line
4. add reference to review board?.

Here is an example:

decisionengine/logicengine: python3 compliance changes 

Replaced string.join() where appropriate 

  RB : https://fermicloud140.fnal.gov/reviews/r/NUMBER/

Then push to the remote:

git push origin master 

Now, open a Pull Request in your fork on github to merge your code into the main repository (merge your-fork --> HEPCloud/decisionengine).

After your PR is merged, you might find that your forked repository shows a different commit history than the upstream repo. This can especially happen if you made any commits during a pull request: these all get squashed into one commit automatically when the PR is merged. The next time you want to resync your master branch, you might have to either

1. Use a pull request to merge HEPCloud/decisionengine into your local repo, or
2. Force a resync of your forked copy of the repository with the main repo. Assuming your git remotes are set like this:

$ git remote -v
origin  https://github.com/<username>/decisionengine.git (fetch)
origin  https://github.com/<username>/decisionengine.git (push)
upstream        https://github.com/HEPCloud/decisionengine.git (fetch)
upstream        https://github.com/HEPCloud/decisionengine.git (push)

you could do the following:

git fetch upstream
git checkout upstream/master
git branch -D master
git checkout -b master
git push --force origin master

Bug fixes to frozen branch

Assumption is: you have fixed the bug and pushed it to master using above procedure. Now we need to have a "production" branch patched.

git checkout <branch>
git pull <branch>
git checkout -b fix/<branch>/<rb number>
git cherry-pick -x <HASH of the bugix commit to master>

Fix conflicts if any

git push <remote> HEAD

Proceed to Web interface and create pull request against <branch>. <remote> is the name of your remote repository. For instance in my case:

[litvinse@orbis decisionengine]$ git remote -v 
litvinse	git@github.com:DmitryLitvintsev/decisionengine.git (fetch)
litvinse	git@github.com:DmitryLitvintsev/decisionengine.git (push)
origin	https://github.com/HEPCloud/decisionengine (fetch)
origin	https://github.com/HEPCloud/decisionengine (push)

The name of remote repository is litvinse.