Gitiles
Code Review Sign In
asterix-gerrit.ics.uci.edu / incubator-asterixdb-site / 12b53a2413c203872cf5c8457f92287391cb817c / . / content / dev-setup.html
blob: 01120754d4b4ed201eff92eefa279cb1508a151c [file] [log] [blame]
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]1<!DOCTYPE html>
2<html lang="en">
3 <head>
4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <meta name="viewport" content="width=device-width, initial-scale=1">
7 <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
8 <meta name="description" content="">
9 <meta name="author" content="">
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]10 <link rel="icon" href="favicon.ico">
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]11
12 <title>Contributing to AsterixDB</title>
13
14 <!-- Bootstrap core CSS -->
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]15 <link href="css/bootstrap.min.css" rel="stylesheet">
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]16 <!-- Bootstrap theme -->
17
18 <!-- Custom styles for this template -->
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]19 <link href="css/theme.css" rel="stylesheet">
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]20
21 <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
22 <!--[if lt IE 9]>
23 <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
24 <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
25 <![endif]-->
26 <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
27 </head>
28
29 <div class="container theme-showcase" role="main">
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame]30 <div class="masthead">
31 <p class="lead">
32 <a href="index.html">
33 <img src="img/asterixdb_tm.png" style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/>
34 </a>
35 </p>
36 </div>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]37
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame]38 <nav class="navbar navbar-default">
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]39 <div class="container">
40 <div class="navbar-header">
41 <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target=".navbar-collapse">
42 <span class="sr-only">Toggle navigation</span>
43 <span class="icon-bar"></span>
44 <span class="icon-bar"></span>
45 <span class="icon-bar"></span>
46 </button>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]47 <a class="navbar-brand" href="index.html">Overview</a>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]48 </div>
49 <div class="navbar-collapse collapse">
50 <ul class="nav navbar-nav">
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]51 <li><a href="download.html">Download</a></li>
Ian Maxona9643c82015-09-01 11:15:57 -1000[diff] [blame]52 <li class="dropdown">
53 <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Documentation<span class="caret"></span></a>
54 <ul class="dropdown-menu" role="menu">
55 <li class="dropdown-header">Stable release</li>
Till Westmanne617e522016-02-29 12:42:51 -0800[diff] [blame]56 <li><a href="docs/0.8.8-incubating/index.html">Documentation for 0.8.8-incubating<i class="fa fa-external-link fa-sm"></i></a></li>
Ian Maxona9643c82015-09-01 11:15:57 -1000[diff] [blame]57 <li class="divider"></li>
58 <li class="dropdown-header">Snapshot release</li>
Ian Maxona1d49092016-03-25 13:24:08 -0700[diff] [blame]59 <li><a href="https://ci.apache.org/projects/asterixdb/index.html">Documentation for 0.8.9-SNAPSHOT <i class="fa fa-external-link fa-sm"></i></a></li>
Ian Maxona9643c82015-09-01 11:15:57 -1000[diff] [blame]60 </ul>
61 </li>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]62 <li><a href="about.html">About</a></li>
Till Westmann2a321022016-04-08 08:18:14 -0700[diff] [blame]63 <li class="dropdown">
64 <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Community<span class="caret"></span></a>
65 <ul class="dropdown-menu" role="menu">
66 <li><a href="community.html">Mailing Lists</a></li>
67 <li><a href="community.html#irc">IRC</a></li>
68 <li><a href="community.html#asterixdb-team">Team</a></li>
69 <li><a href="https://issues.apache.org/jira/browse/ASTERIXDB">Issue Tracker</a></li>
70 </ul>
71 </li>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]72 <li class="dropdown">
73 <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Contributing <span class="caret"></span></a>
74 <ul class="dropdown-menu" role="menu">
75 <li class="dropdown-header">For New Contributors</li>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]76 <li><a href="dev-setup.html">Development Setup</a></li>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]77 <li class="divider"></li>
78 <li class="dropdown-header">For Committers</li>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]79 <li><a href="pushing.html">Pushing changes</a></li>
80 <li><a href="site.html">Editing this site</a></li>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]81 </ul>
82 </li>
83 </ul>
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame]84 <ul class="nav navbar-nav navbar-right">
85 <li class="dropdown">
86 <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false"
87 style="padding-right: 30px">
88 <img src="img/feather.png" style="height:20px"/>Apache Software Foundation<span class="caret"/>
89 </a>
90 <ul class="dropdown-menu dropdown-menu-right" role="menu">
91 <li><a href="http://www.apache.org/"><b>ASF Homepage</b></a></li>
92 <li><a href="http://www.apache.org/licenses/">License</a></li>
93 <li><a href="http://www.apache.org/foundation/sponsorship.html">Donate</a></li>
94 <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
95 <li><a href="http://www.apache.org/security/">Security</a></li>
96 </ul>
97 </li>
98 </ul>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]99 </div><!--/.nav-collapse -->
100 </div>
101 </nav>
102
103
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame]104 <div class="row">
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]105<div class="col-md-8 col-centered">
106<h2>Contributing to AsterixDB</h2>
107<hr />
108
109<ul id="markdown-toc">
110 <li><a href="#introduction" id="markdown-toc-introduction">Introduction</a></li>
Ian Maxonacb58492015-10-16 19:12:28 -0700[diff] [blame]111 <li><a href="#master-snapshots" id="markdown-toc-master-snapshots">Master snapshots</a> <ul>
112 <li><a href="#managix-installer" id="markdown-toc-managix-installer">Managix Installer</a></li>
113 <li><a href="#yarn-installer" id="markdown-toc-yarn-installer">YARN Installer</a></li>
114 </ul>
115 </li>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]116 <li><a href="#setting-up-an-asterix-development-environment-in-eclipse" id="markdown-toc-setting-up-an-asterix-development-environment-in-eclipse">Setting up an Asterix Development environment in Eclipse</a> <ul>
117 <li><a href="#prerequisites" id="markdown-toc-prerequisites">Prerequisites</a></li>
118 <li><a href="#steps" id="markdown-toc-steps">Steps</a></li>
119 </ul>
120 </li>
121 <li><a href="#signing-up-for-gerrit" id="markdown-toc-signing-up-for-gerrit">Signing Up for Gerrit</a></li>
122 <li><a href="#configuring-your-local-working-environment-for-gerrit" id="markdown-toc-configuring-your-local-working-environment-for-gerrit">Configuring your local working environment for Gerrit</a> <ul>
123 <li><a href="#one-time-tasks" id="markdown-toc-one-time-tasks">One-time tasks</a></li>
124 <li><a href="#once-per-repository-tasks" id="markdown-toc-once-per-repository-tasks">Once-per-repository tasks</a></li>
125 </ul>
126 </li>
127 <li><a href="#making-changes---working-method" id="markdown-toc-making-changes---working-method">Making Changes - working method</a></li>
128 <li><a href="#making-more-changes" id="markdown-toc-making-more-changes">Making More Changes</a></li>
129 <li><a href="#using-jenkins-with-gerrit" id="markdown-toc-using-jenkins-with-gerrit">Using Jenkins with Gerrit</a> <ul>
130 <li><a href="#verification" id="markdown-toc-verification">Verification</a></li>
131 <li><a href="#retrigggering-builds-and-triggering-builds-manually" id="markdown-toc-retrigggering-builds-and-triggering-builds-manually">Retrigggering builds and triggering builds manually</a></li>
132 <li><a href="#cross-project-dependencies" id="markdown-toc-cross-project-dependencies">Cross-project Dependencies</a></li>
133 </ul>
134 </li>
135</ul>
136
137<hr />
138
139<h2 id="introduction">Introduction</h2>
Till Westmanndadc9b72016-04-26 17:24:34 -0700[diff] [blame]140<p>We warmly welcome any contributions to the Apache AsterixDB™ or related (Hyracks, Pregelix) projects.
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame]141A great way to start contributing is to pick a bug labelled starter in JIRA and submit a patch for it, to get acquainted with our codebase and development process.</p>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]142
143<hr />
144
Ian Maxonacb58492015-10-16 19:12:28 -0700[diff] [blame]145<h2 id="master-snapshots">Master snapshots</h2>
146<p>If you are a developer simply looking for a snapshot of the latest development version of AsterixDB to test out your application that is based on top of AsterixDB, snapshots from the latest successful push to our master branch are available below. These are non ASF-release, automatic builds.</p>
147
148<h3 id="managix-installer">Managix Installer</h3>
Ian Maxona1d49092016-03-25 13:24:08 -0700[diff] [blame]149<p><a class="btn btn-md btn-warning" href="https://asterix-jenkins.ics.uci.edu/job/asterix-integration-tests/lastSuccessfulBuild/org.apache.asterix$asterix-installer/artifact/org.apache.asterix/asterix-installer/0.8.9-SNAPSHOT/asterix-installer-0.8.9-SNAPSHOT-binary-assembly.zip" role="button">Download AsterixDB 0.8.9-SNAPSHOT <i class="fa fa-download fa-lg"></i> </a></p>
Ian Maxonacb58492015-10-16 19:12:28 -0700[diff] [blame]150
151<h3 id="yarn-installer">YARN Installer</h3>
Ian Maxona1d49092016-03-25 13:24:08 -0700[diff] [blame]152<p><a class="btn btn-md btn-warning" href="https://asterix-jenkins.ics.uci.edu/job/asterix-integration-tests/lastSuccessfulBuild/org.apache.asterix$asterix-yarn/artifact/org.apache.asterix/asterix-yarn/0.8.9-SNAPSHOT/asterix-yarn-0.8.9-SNAPSHOT-binary-assembly.zip" role="button">Download AsterixDB 0.8.9-SNAPSHOT <i class="fa fa-download fa-lg"></i> </a></p>
Ian Maxonacb58492015-10-16 19:12:28 -0700[diff] [blame]153
154<hr />
155
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]156<h2 id="setting-up-an-asterix-development-environment-in-eclipse">Setting up an Asterix Development environment in Eclipse</h2>
157
158<h3 id="prerequisites">Prerequisites</h3>
159<ul>
160 <li>A suitable *nix environment (Linux, OSX)</li>
Ian Maxon1bd67772015-11-12 16:14:20 -0800[diff] [blame]161 <li>JDK 1.8+</li>
162 <li>Maven 3.1.1 or greater</li>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]163 <li>A relatively recent version of Eclipse</li>
164</ul>
165
166<h3 id="steps">Steps</h3>
167
168<ol>
Till Westmann0cf36632015-12-08 21:57:33 -0800[diff] [blame]169 <li>
Taewoo Kim12b53a22016-07-08 14:02:15 -0700[diff] [blame^]170 <p>Check out AsterixDB master in one folder via git in the command line. Assume that the path is <code>$HOME/workspace</code>.</p>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]171
Taewoo Kim12b53a22016-07-08 14:02:15 -0700[diff] [blame^]172 <pre><code> git clone https://github.com/apache/asterixdb/
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]173</code></pre>
174
Taewoo Kim12b53a22016-07-08 14:02:15 -0700[diff] [blame^]175 <p>You will now have <code>$HOME/workspace/asterixdb/</code>.</p>
Till Westmann0cf36632015-12-08 21:57:33 -0800[diff] [blame]176 </li>
177 <li>
Taewoo Kim12b53a22016-07-08 14:02:15 -0700[diff] [blame^]178 <p>Go to the asterixdb folder and install it’s artifacts to the local Maven repository by executing the following commands:</p>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]179
Taewoo Kim12b53a22016-07-08 14:02:15 -0700[diff] [blame^]180 <pre><code> cd asterixdb/
Till Westmann0cf36632015-12-08 21:57:33 -0800[diff] [blame]181 mvn install -DskipTests
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]182</code></pre>
Till Westmann0cf36632015-12-08 21:57:33 -0800[diff] [blame]183 </li>
Taewoo Kim12b53a22016-07-08 14:02:15 -0700[diff] [blame^]184 <li>In Eclipse, import asterixdb as an existing Maven Project.
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]185 <ul>
186 <li><code>File -&gt; Import -&gt; Maven -&gt; Existing Maven Projects -&gt; Next</code></li>
Taewoo Kim12b53a22016-07-08 14:02:15 -0700[diff] [blame^]187 <li>Specify the Root directory as <code>asterixdb</code> and then click Next until Finish is enabled.</li>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]188 <li>If Eclipse tries to install the <code>m2e</code> (Maven To Eclipse) connector, let it do so.</li>
189 <li>There might be some plugin errors; however, that is not a big deal. Wait until the job finishes.</li>
Taewoo Kim12b53a22016-07-08 14:02:15 -0700[diff] [blame^]190 <li>Then, click Finish. Restart Eclipse if asked to do so.</li>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]191 </ul>
192 </li>
193 <li>Fix Eclipse’s build path to include compile-time generated sources.
194 <ul>
195 <li>Right click the project where a red X mark is shown(e.g. <code>asterix-algebra</code>. Then resolve by applying the following:
196 <ul>
197 <li>Right click asterix-algebra. Click Build Path and Configure Build Path. Click Add Folder.</li>
Taewoo Kim12b53a22016-07-08 14:02:15 -0700[diff] [blame^]198 <li>Under the <code>target -&gt; generated sources</code>, check the parent folder of the <code>org</code> folder and click OK.</li>
Ian Maxon4baed872015-10-06 19:01:17 -0700[diff] [blame]199 <li>For example, if the directory structure is “target - generated-sources - javacc - org - apache …”, check the javacc directory and click OK. Then X mark will dissapear.</li>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]200 </ul>
201 </li>
202 <li>Repeat this step to all projects which show a red X mark except “asterix-fuzzyjoin” and “asterix-transactions”.</li>
Taewoo Kim12b53a22016-07-08 14:02:15 -0700[diff] [blame^]203 <li>It may be the case that only “asterix-algebra” and “asterix-external-data” will require these steps.</li>
204 <li>If you see “plugin execution not covered by lifecycle configuration” errors such as this one - “Plugin execution not covered by lifecycle configuration: org.apache.asterix:asterix-test-datagenerator-maven-plugin:0.8.9-SNAPSHOT:generate-testdata (execution: replace-template-data, phase: process-test-resources)”, try to resolve it using the quick fix feature. You can call this feature by right click on the error and select “quick fix”. And then choose “Mark goal generate-testdata as ignored in Eclipse build in Eclipse preferences”.</li>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]205 </ul>
206 </li>
207 <li>Set up Eclipse code formatting rules
208 <ul>
Till Westmann0cf36632015-12-08 21:57:33 -0800[diff] [blame]209 <li>Download files <a href="https://cwiki.apache.org/confluence/download/attachments/61322291/AsterixCodeFormatProfile.xml">AsterixCodeFormatProfile.xml</a>
210 <a href="https://cwiki.apache.org/confluence/download/attachments/61322291/AsterixCleanupFormatProfile.xml">AsterixCleanupFormatProfile.xml</a></li>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]211 <li>Import profiles into Eclipse
212 <ul>
213 <li>Preferences -&gt; Java -&gt; Code style -&gt; Formatter -&gt; Import -&gt; Select AsterixCodeFormatProfile.xml</li>
214 <li>Preferences -&gt; Java -&gt; Code style -&gt; Clean up -&gt; Import -&gt; Select AsterixCleanupFormatProfile.xml</li>
215 <li>Preferences -&gt; Java -&gt; Editor -&gt; Save actions -&gt; Perform the selected action on save -&gt; Format source code</li>
216 </ul>
217 </li>
218 </ul>
219 </li>
Taewoo Kim12b53a22016-07-08 14:02:15 -0700[diff] [blame^]220 <li>
221 <p>Lastly, go to the asterixdb folder and execute following command again. This is required since Eclipse might have cleaned the projects and rebuilt the them without creating all necessary classes. Currently, some of the class files can be only built using mvn command.</p>
222
223 <pre><code> cd asterixdb/
224 mvn install -DskipTests
225</code></pre>
226 </li>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]227</ol>
228
229<hr />
230
231<h2 id="signing-up-for-gerrit">Signing Up for Gerrit</h2>
232
Ian Maxon4baed872015-10-06 19:01:17 -0700[diff] [blame]233<p>First, to contribute patches to AsterixDB, you should have an ICLA on file with the Apache Software Foundation.
234For details see the ASF website <a href="https://www.apache.org/dev/new-committers-guide.html#cla">here</a>
235You should only need to perform the following steps once.</p>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]236
237<p>Our Gerrit server is <a href="https://asterix-gerrit.ics.uci.edu/">here</a></p>
238
239<ol>
240 <li>Visit the above URL, and click on “Register” in the upper right.</li>
241 <li>Gerrit uses OpenID; you may create an account using any OpenID provider, or with a Yahoo! account.</li>
242 <li>Click on “Sign in with a Yahoo! ID”. You will be taken to a page to log in to Yahoo!.</li>
243 <li>From there, you will get a page asking you to allow asterix-gerrit.ics.uci.edu to access your email and basic information. Approve this request.</li>
244 <li>You will be directed back to Gerrit to complete the account signup. Make sure to fill out this page! It is necessary to allow you to push code changes to Gerrit for review.</li>
245 <li>For “Full Name” and “Preferred Email”, enter what you like. If you would like to register a different email address such as an @uci.edu address, you may do so. This is where Gerrit will send you notifications about code review requests, voting, and so on.</li>
246 <li>For “Select a unique username”, choose a short alphanumeric ID. This will be your ssh username for git access. Be sure to click “Select Username” to verify that the name is unique and allowed.</li>
247 <li>Also provide a ssh public key here. There is information on the page on creating one if you do not have one. Click “Add” when done.
248 * Note that you can create a new ssh public key just for Gerrit if you like; if you do so you will need to modify your .ssh/config file to ensure the right key is selected.</li>
249 <li>Click “Continue” at the bottom of the page.</li>
250 <li>
251 <p>Finally, verify that you have everything set up: From a command-line, type
252<code>
253ssh -p 29418 username@asterix-gerrit.ics.uci.edu
254</code></p>
255 </li>
256 <li>You should see</li>
257</ol>
258
259<pre><code> **** Welcome to Gerrit Code Review ****
260
261 Hi Full Name, you have successfully connected over SSH.
262
263 Unfortunately, interactive shells are disabled.
264 To clone a hosted Git repository, use:
265
266 git clone ssh://username@asterix-gerrit.ics.uci.edu:29418/REPOSITORY_NAME.git
267
268</code></pre>
269
270<p>At this point, please send an email to Chris or Ian, specifying the email address of your new account, and ask to be added to the “AsterixDB Devs” group. You may push change proposals to Gerrit, and vote +1/-1 Code Review on any proposals without being in AsterixDB Devs, but you cannot vote +2 on anything to allow a change to be merged.</p>
271
272<hr />
273
274<h2 id="configuring-your-local-working-environment-for-gerrit">Configuring your local working environment for Gerrit</h2>
275
276<h3 id="one-time-tasks">One-time tasks</h3>
277
278<ol>
279 <li>At the command-line, run the following. Replace “username” with the user name you chose in step 7 above.
280<code>
281git config --global gerrit.url ssh://username@asterix-gerrit.ics.uci.edu:29418/
282</code></li>
283 <li>Download my “git-gerrit” utility library:
284<code>
285git clone https://github.com/ceejatec/git-gerrit
286</code></li>
287 <li>Ensure that the <code>git-gerrit/git-gerrit</code> script is on your PATH. You could copy it to somewhere, but it would be best to leave it inside the github clone so you can easily get updates.</li>
288</ol>
289
290<h3 id="once-per-repository-tasks">Once-per-repository tasks</h3>
291
292<ol>
Till Westmann0cf36632015-12-08 21:57:33 -0800[diff] [blame]293 <li>
294 <p>To work on (say) Asterix, first clone the GitHub mirror or the ASF repository (if you already have a local clone, great!), e.g.</p>
295
296 <p>git clone https://github.com/apache/incubator-asterixdb</p>
297 </li>
298 <li>
299 <p><code>cd</code> into the clone repo directory, and then run the following command to create the “gerrit” remote.</p>
300
301 <p>git gerrit init</p>
302 </li>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]303</ol>
304
305<hr />
306
307<h2 id="making-changes---working-method">Making Changes - working method</h2>
308
309<ol>
Till Westmann0cf36632015-12-08 21:57:33 -0800[diff] [blame]310 <li>
311 <p>When you want to start working on a bug, feature, etc, first make a local <code>git</code> branch. Never work directly on
312 <code>master</code>! <code>master</code> should always be a pure mirror of <code>origin/master</code>, i.e., the GitHub mirror or the ASF repository.</p>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]313
Till Westmann0cf36632015-12-08 21:57:33 -0800[diff] [blame]314 <pre><code> git checkout -b my_branch
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]315</code></pre>
Till Westmann0cf36632015-12-08 21:57:33 -0800[diff] [blame]316 </li>
317 <li>
318 <p>Make your changes, test them, etc. Feel free to <code>git commit</code> as often as you like.</p>
319 </li>
320 <li>
321 <p><strong>Optional</strong>: If you like, you can push your branch up to another git repository (e.g. in your own GitHub account), either to share it with others or as a backup. You may do this at whatever point in time you like.</p>
322 </li>
323 <li>
324 <p>Every so often, you should update your local <code>master</code> mirror, and then merge that onto your working branch. This will prevent your branch from falling too far out of date, and ensure that your code review proposals will merge successfully with <code>master</code>. There are a number of ways to do this, but <code>git-gerrit</code> provides a convenience function:</p>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]325
Till Westmann0cf36632015-12-08 21:57:33 -0800[diff] [blame]326 <pre><code> git gerrit update
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]327</code></pre>
Till Westmann0cf36632015-12-08 21:57:33 -0800[diff] [blame]328 </li>
329 <li>
330 <p>When you are ready to submit changes for code review, first ensure that you have committed everything locally that is necessary (<code>git status</code> should report “nothing to commit, working directory clean”). This is also a good time to update (see step 4). Then run:</p>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]331
Till Westmann0cf36632015-12-08 21:57:33 -0800[diff] [blame]332 <pre><code> git gerrit submit
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]333</code></pre>
Till Westmann0cf36632015-12-08 21:57:33 -0800[diff] [blame]334 </li>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]335 <li>This will pop open your editor to invite you to create a good commit message. This will be the single commit message which will be the only one to appear in the project’s master git history. Take the time to make it clear. The editor will contain the log messages of everything you committed on your branch as a reminder, but generally you will want to delete all this and replace it with a comprehensive message. Also: As noted in the initial message, the last line of the buffer will contain a <code>Change-Id</code> field. Do not delete that line! It is used by Gerrit to identify this particular merge proposal.</li>
Till Westmann0cf36632015-12-08 21:57:33 -0800[diff] [blame]336 <li>
337 <p>When you save your commit message, git-gerrit will push all of the changes from your working branch up to Gerrit. Assuming no errors, you should see output similar to the following:</p>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]338
Till Westmann0cf36632015-12-08 21:57:33 -0800[diff] [blame]339 <pre><code> remote: Resolving deltas: 100% (1/1)
340 remote: Processing changes: new: 1, refs: 1, done
341 remote:
342 remote: New Changes:
343 remote: http://fulliautomatix.ics.uci.edu:8443/30
344 remote:
345 To ssh://ceej@fulliautomatix.ics.uci.edu:29418/ceej-gerrit-test
346 * [new branch] HEAD -&gt; refs/for/master
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]347</code></pre>
Till Westmann0cf36632015-12-08 21:57:33 -0800[diff] [blame]348 </li>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]349 <li>That URL under “New Changes” is your code review! Send it to others to request reviews.</li>
350 <li>If you get any negative code reviews and need to make changes, you can just repeat steps 2 - 6 of the working method. Your local branch will still have all the history you put there, if you need to revert changes or look back and see what you did, etc.</li>
351 <li>When you repeat step 6, you will notice two things: First, git-gerrit keeps the change message for you, including the Change-Id, so you don’t have to re-invent it every time. Second, the output from <code>git gerrit submit</code> will not include the URL of the review this time. I’m not sure why; I wish it did. But if you re-visit the old URL in your browser, you should see an additional “Patch Set” containing your revised changes for people to review.</li>
352</ol>
353
354<h2 id="making-more-changes">Making More Changes</h2>
355
356<p>You may have as many feature branches as you want locally, and each may be at any point in the review cycle.</p>
357
358<p>Once you are done with a change (that is, it has been Code Reviewed and approved in Gerrit and merged), it is probably best to start work on the next big thing on a new branch. However, git-gerrit attempts to be smart if you choose to re-use a branch. For example, it should notice if the “current” Change-Id for a branch has been merged to master, and it will create a new Change-Id and a new fresh commit message the next time you run <code>git gerrit submit</code>.</p>
359
360<p>In that case, you may notice that the list of changes on the branch still contains older commits which have been merged. That is due to the unfortunate way Gerrit works; it requires squashing to a single git commit for review, which loses the association with the original commits in your history.</p>
361
362<p>It is also possible that you may want to re-use a branch and git-gerrit fails to notice that the older change has been merged - or perhaps the change was Abandoned on Gerrit and not merged, and you want to continue working on the same branch to create a new proposal. In this case, run
363<code>
364git gerrit new
365</code>
366on your branch. This will force git-gerrit to create a new Change-Id and commit message the next time you run <code>git gerrit submit</code>.</p>
367
368<hr />
369
370<h2 id="using-jenkins-with-gerrit">Using Jenkins with Gerrit</h2>
371
372<h3 id="verification">Verification</h3>
373
374<p>As of right now, whenever a patch set is submitted to Gerrit (i.e. whenever a user performs ‘git gerrit submit’) are automatically picked up by Jenkins, which runs <code>mvn verify</code> to test the patch fully. Once the build finishes, Jenkins comments on the patchset and votes with the result (+1 for all tests passing, -1 for anything less). Ideally, and in most cases, verifocation of a patchset reqires no intervention. However there are a few exceptions to this as detailed below.</p>
375
376<h3 id="retrigggering-builds-and-triggering-builds-manually">Retrigggering builds and triggering builds manually</h3>
377
378<h4 id="retriggering">Retriggering</h4>
379<p>Occasionally, there are builds in which tests failed, but perhaps not for a reason that has anything to do with the proposed patch’s changes. For example, on occasion the Integration tests can have issues with ports on the build server already being bound. The simple work around to this is to try building again.</p>
380
381<p>One way to perform this is by simply visiting the link that is posted on Gerrit by Jenkins, and hitting the ‘Retrigger’ link on the left-hand side of the page. This will try retesting the build with the exact same parameters as last time, hopefully with a different result.</p>
382
383<h4 id="manual-trigger">Manual Trigger</h4>
384<p>Builds of Gerrit patches can also be fully manually triggered from Jenkins. This can be desirable if a change is now dependent on a Hyracks change (via the Topic field feature described below), or if the patch is a draft or is not triggered automatically for any other reason. To manually trigger a build of a patchset, visit the Jenkins front-page, and click the ‘Query and Trigger Gerrit patches’ link. This should link to a page allowing you to manually trigger Gerrit patches. In the search field any query that can be searched in the Gerrit web interface can be used, but the default query of all open patchsets is likely fine. Hit the ‘Search’ button, and then click the checkbox that represents the patch that needs to be built. Then simply click ‘Trigger Selected’ and the patch will start building.</p>
385
386<h3 id="cross-project-dependencies">Cross-project Dependencies</h3>
387
388<p>It is sometimes the case that a change in one related project alters interfaces or expected results that an upstream project relies on. The converse can be true as well, such as an AsterixDB change that needs a Hyracks feature. In these sorts of situations, there is a mechanism to describe to Jenkins this dependenc of one project’s patchset to a particular Hyracks Change, by using the ‘Topic’ field in Gerrit. To utilize
389this feature, perform the following steps:</p>
390
391<ol>
392 <li>First submit the Hyracks change which the upstream (AsterixDB,etc..) change depends on if you have not done so already</li>
393 <li>In the Hyracks change details on the Gerrit web interface, take note of the refspec in the <em>Download</em> field of the patchset details. It will look something like <code>refs/changes/07/207/1</code>. This is what uniquely identifies the Hyracks change in Gerrit.</li>
394 <li>Submit the dependent change now, if you have not done so already. In the Gerrit web interface, view the change’s details. In the upper left-hand corner, there will be an empty field in a table, labeled <code>Topic</code>, with a notepad icon right-justified in the second column of the table. Click the notepad Icon, and in the resulting dialog box, enter in the refspec (<code>refs/changes/07/207/1</code>) as the Topic value.</li>
395 <li>Now, manually trigger the dependent change in Jenkins (see previous section for details)</li>
396</ol>
397
398<hr />
399
400</div>
401</div>
402
403
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame]404 <hr/>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]405
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame]406 <footer>
407 <div class="row">
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame]408 <div class="col-md-9 col-centered text-center">
409 <p/>
410 <p>&copy; Copyright 2016 The Apache Software foundation. All Rights Reserved. </p>
411 <p>Apache AsterixDB, the Apache AsterixDB logo, Apache, and the Apache feather logo are trademarks of the
412 Apache Software Foundation</p>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]413 </div>
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame]414 </div>
415 </footer>
416 </div> <!-- /container -->
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]417
418 <!-- Bootstrap core JavaScript
419 ================================================== -->
420 <!-- Placed at the end of the document so the pages load faster -->
421 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]422 <script src="js/bootstrap.min.js"></script>
Ian Maxon3dffc852015-07-13 20:17:09 -0700[diff] [blame]423 </body>
424</html>