Difference between revisions of "PTP/Gerrit"

Revision as of 19:41, 21 November 2013

PTP Gerrit

UNDER DEVELOPMENT

What PTP contributors (committers and others) need to do for the basic tasks

PART 1 - What PTP contributors need to do to add a proposed fix/patch to Gerrit

1. Clone the repo
2. Configure the repo to use Gerrit (modify or create a remote that uses port 29418 or git.eclipse.org/r -- should be in Environment Setup page on wiki
3. Make changes
4. Commit the changes (to local repo) making sure that the commit includes Signed-off-by and Change-Id lines#. Team>Remote>Push to Gerrit...

See also Using Gerrit for CDT as our use should be similar/same.

PART 2 - What a committer needs to do to pull a gerrit patch in, see its changes, and later commit it to the repo to get in the build.

1. The change is presumably documented in a bugzilla bug, e.g. https://bugs.eclipse.org/bugs/show_bug.cgi?id=407003
2. Go to the URL for the change (e.g. bug 407003 has a link to https://git.eclipse.org/r/#/q/status:open+project:ptp/org.eclipse.ptp,n,z which has 10 Gerrit patch sets(?) for this bug) - a patch set is a single commit?
3. Open the Patch Set (e.g. open the top one in the list under the heading "File Path" for this bug 407003)
   • Patch set actions:
     • Click on each file to see e.g, a diff viewer of the changes, comparing old and new. Review the changes, add comments to the author in line if required
     • To add an inline comment, click on the line number on the far right in the diff viewer
     • The "Download" field on the main screen shows different ways of obtaining the changes in order to test in your local repo (from command line only)
       • Issue the command in the directory that is the location of the git repo.
       • this will create a new branch for the changes, change the repo so this is the default branch, and your eclipse workspace will be changed to show that branch.
     • On the main screen, click on the "Review" button and add an overall comment on the change
       • Verified: choose +1, 0 or -1
       • Code Review: choose +2 to -2 - +2 indicates approval of e.g. a committer - this accepts the change.
       • IP-Clean: +1, 0, -1 (is +1 required if contributor/author has filled out legal docs? +1 is required to finish; I am assuming if contributed has filled out docs, i can indicate +1)
       • Overall comment at bottom as "Cover Message"
         • Use "Publish Comments" to add the comment only (so author/contributor is notified and can see it)
         • Once there is a +2 vote, Use "Publish and Submit" to ... to push the changes to the main repo
         • To add an overall comment --another button at bottom appears "Add Comment"
4. If the change is rejected, the contributor can upload a new patch set, then the process is repeated
5. Watch emails and follow links to see if the change can be merged.
   • e.g. i got at bottom of patch set page after following link in email: "The following changes must also be submitted" with links to 4-5 more change sets(?) but no descriptions

We also plan to add an auto build step so that hudson will automatically try to build with the change (and run tests too). If the build succeeds, hudson will vote on the change. The Gerrit-based build is separate from the build based on code committed to the repository.