platform-ui-home/builds/index.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.12 - (view) (download) (as text)

1 : dpollock 1.1 <html>
2 :     <head>
3 :     <title>Builds (Platform-UI)</title>
4 :     <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
5 :     <link rel="stylesheet" href="http://dev.eclipse.org/default_style.css" type="text/css">
6 :     </head>
7 :    
8 :     <body bgcolor="#FFFFFF" text="#000000">
9 :    
10 : dpollock 1.3 <table border=0 cellspacing=5 cellpadding=2 width="100%">
11 :     <tr>
12 :     <td align=left width="72%">
13 :     <font class=indextop>Builds</font><br>
14 :     <font class=indexsub>platform user interface</font>
15 :     </td>
16 :     <td width="28%">
17 :     <img src="http://dev.eclipse.org/images/Idea.jpg" height=86 width=120 alt="Eclipse documentation banner">
18 :     </td>
19 :     </tr>
20 :     </table>
21 :     <table border=0 cellspacing=5 cellpadding=2 width="100%">
22 : dpollock 1.1 <tr>
23 : dpollock 1.3 <td align=LEFT valign=TOP bgcolor="#0080C0">
24 :     <b><font color="#FFFFFF" face="Arial,Helvetica">Topics</font></b>
25 :     </td>
26 : dpollock 1.1 </tr>
27 : dpollock 1.3 <tr>
28 :     <td width="98%">
29 :     <b>Topics</b>
30 :     <ul>
31 :     <li><a href="#BUILDS">Build Submissions</a></li>
32 :     <li><a href="#INSTALLING">Installing Release Engineering Tools</a></li>
33 :     <li><a href="#RELENGMAP">Making a Build Submission with Release
34 :     Engineering Tools</a></li>
35 :     <li><a href="#CVSMAP">Making a Build Submission with CVS Only</a></li>
36 :     <li><a href="#RECOVERY">Recovery Builds</a></li>
37 :     </ul>
38 :     </td>
39 :     </tr>
40 :     </table>
41 :     <a name="BUILDS">
42 :     <table border=0 cellspacing=5 cellpadding=2 width="100%">
43 :     <tr>
44 :     <td align=LEFT valign=TOP bgcolor="#0080C0">
45 :     <b><font color="#FFFFFF" face="Arial,Helvetica">Build Submissions</font></b>
46 :     </td>
47 :     </tr>
48 :     <tr>
49 :     <td width="98%">
50 :     <p>Build submissions are done before every integration build and
51 :     milestone build. Integration builds typically occur on Tuesday. Please
52 :     see the <a href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-releng-home/index.html">Platform
53 :     Release Engineering</a> page for more information. We do our build
54 :     submission for an 8 a.m. build, at 4 p.m. the previous day.</p>
55 :     <p>If you miss the cut-off for the official build submission, but
56 :     it is still before the build has started, then you can do your own build
57 :     submission to make sure your fix gets into the build.</p>
58 :     <p>A warning email should be sent to "platform-ui-dev@eclipse.org" (or
59 :     all committers) at the beginning of the days on which an official build
60 :     submission is to occur, or if you do your own build submission.</p>
61 :     </tr>
62 :     </table>
63 :     <a name="INSTALLING">
64 :     <table border=0 cellspacing=5 cellpadding=2 width="100%">
65 : dpollock 1.1 <tr>
66 : dpollock 1.3 <td align=LEFT valign=TOP bgcolor="#0080C0">
67 :     <b><font color="#FFFFFF" face="Arial,Helvetica">Installing the Release Engineering Tool</font></b>
68 :     </td>
69 :     </tr>
70 :     <tr>
71 :     <td>
72 : dpollock 1.1 <p>The Platform-UI team suggests that the Release Engineering (releng)
73 :     tool be installed before doing a build submission. It reduces the
74 :     chance of error.</p>
75 :     <ol>
76 :     <li>Exit Eclipse (if running)</li>
77 : karice 1.11 <li>Download the <a href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-releng-home/org.eclipse.releng.tools_3.1.0.zip">releng tool</a>.</li>
78 : dpollock 1.1 <li>Unzip the tool into your <code>plugins</code> directory.</li>
79 :     <li>Start Eclipse</li>
80 :     </ol>
81 : dpollock 1.3 </td>
82 :     </tr>
83 :     </table>
84 :     <a name="RELENGMAP">
85 :     <table border=0 cellspacing=5 cellpadding=2 width="100%">
86 :     <tr>
87 : karice 1.10 <td align=LEFT valign=TOP bgcolor="#0080C0"> <b><font color="#FFFFFF" face="Arial,Helvetica">Making
88 :     a Build Submission with the Release Engineering Tool</font></b> </td>
89 :     </tr>
90 :     <tr>
91 :     <td> <ol>
92 :     <li>Make sure that your workspace contains all of the plug-ins contained
93 :     in our modules. This includes <code>plat-ui</code>, <code>plat-ui-examples</code>
94 :     and <code>plat-ui-tests</code>. Make sure to include fragments that
95 :     are not appropriate for your platform, as they may need to be versioned
96 : karice 1.12 as well. Check out the project <code>org.eclipse.releng</code> from HEAD. </li>
97 : karice 1.10 <li>Get rid of all outgoing changes in your workspace.</li>
98 :     <li>Run all the test suites. The definitive list of test suites is given
99 :     by inspecting the <code>test.xml</code> files in all our test plug-ins.
100 :     At the time of writing, they are roughly: databinding tests, navigator
101 :     tests, parts references tests, session tests, rcp tests, JFace tests,
102 : karice 1.11 tabbed properties view tests, and the rather large UiTestSuite. There are launch configurations that you can find in the debug/run launch dialog when you load all the test projects. You can use these to run the tests, rather than creating new ones. <em>Be careful not to disturb focus
103 : karice 1.10 while the test are running. If you're leaving the machine running, you
104 :     may wish to increase the time it takes for the screensaver to kick in.</em></li>
105 :     <li>Run the <a href="cvs-comment.sh">build notes script</a>. On Windows
106 :     XP, I would recommend installing <a
107 :     href="http://www.cygwin.com">cygwin</a>. Check to make sure the list
108 :     of bugs fixed makes sense. To run the build script, execute the following:
109 :     <br>
110 :     <em>&nbsp;cvs-comment.sh TYYYYMMDD-HHHH HEAD workspace-location &gt; log.txt</em><br>
111 :     where TYYYYMMDD-HHHH is when the build is scheduled to start, HEAD is
112 :     the stream to check, workspace location is the directory that contains the build workspace, and log.txt is the file to which the results will
113 :     be written.</li>
114 :     <li>Update the <code>org.eclipse.ui/buildnotes_workbench.html</code> file
115 :     with the results of the build scripts. Commit to CVS.</li>
116 :     <li>Select a project in the Package Explorer, right-click and select "Team
117 :     > Release".</li>
118 :     <li>Use the default map project, and then select all the projects in the
119 :     "ui.map" file.</li>
120 :     <li>If the release is small, it is a good idea to check the list of changes.</li>
121 :     <li>Supply the name of the release. Our convention is to use TYYYYMMDD-HHHH,
122 :     where T is the type (e.g., I for an integration build), YYYY is the
123 :     year, MM is the month, DD is the day and HHHH is the hour the build
124 :     is scheduled to start. If the name is already in use, then use a letter
125 :     suffix (i.e., a, b, c, etc.).</li>
126 :     <li>As the commit comment, enter the information from the build notes
127 :     script.</li>
128 :     <li>Send an email to <a
129 :     href="mailto:platform-ui-dev@eclipse.org">platform-ui-dev</a> with
130 :     the information from the build notes script.</li>
131 :     </ol></td>
132 : dpollock 1.3 </tr>
133 :     <tr>
134 : karice 1.10 <td>&nbsp;</td>
135 : dpollock 1.3 </tr>
136 :     </table>
137 :     <a name="CVSMAP">
138 :     <table border=0 cellspacing=5 cellpadding=2 width="100%">
139 :     <tr>
140 :     <td align=LEFT valign=TOP bgcolor="#0080C0">
141 :     <b><font color="#FFFFFF" face="Arial,Helvetica">Making a Build Submission with CVS Only</font></b>
142 :     </td>
143 :     </tr>
144 :     <tr>
145 :     <td>
146 : dpollock 1.9 <p>To do a build submission using CVS, use the above steps above, but do
147 :     the following instead of using the releng tool:</p>
148 : dpollock 1.1 <ol>
149 :     <li>Tag all projects you have changed with the name of the release. Our
150 : dpollock 1.9 convention is to use TYYYYMMDD-HHHH, where T is the type (e.g., I for an
151 :     integration build), YYYY is the year, MM is the month, DD is the day and
152 :     HHHH is the hour the build is scheduled to start. If the name is already
153 :     in use, then use a letter suffix (i.e., a, b, c, etc.).</li>
154 : dpollock 1.1 <li>Checkout "org.eclipse.releng".</li>
155 :     <li>Open "<code>maps/ui.map</code>".</li>
156 :     <li>Change the version(s) of the project(s) you have tagged.</li>
157 :     <li>Save the map.</li>
158 :     <li>Commit your changes to the map to CVS.</li>
159 :     </ol>
160 : dpollock 1.3 <p>
161 :     </td>
162 :     </tr>
163 :     </table>
164 :     <a name="RECOVERY">
165 :     <table border=0 cellspacing=5 cellpadding=2 width="100%">
166 :     <tr>
167 :     <td align=LEFT valign=TOP bgcolor="#0080C0">
168 :     <b><font color="#FFFFFF" face="Arial,Helvetica">Recovery Builds</font></b>
169 : dpollock 1.1 </td>
170 : dpollock 1.3 </tr>
171 :     <td>
172 :     <p>In the event of a test failure, our team must respond to
173 : dpollock 1.9 <a href="mailto:platform-releng-dev@eclipse.org">platform-releng-dev</a>
174 :     with one of two responses. We can say that we want a recovery build the
175 :     following day. Alternatively, we can say that the test failure is not
176 :     significant, and that the quality of the build should not be affected.
177 :     (In either case, a bug should likely be entered into the bug
178 :     database.)</p>
179 : dpollock 1.3 <p>A recovery build can also be requested if there is a problem affecting
180 :     the usability of the build. This problem should make the build unusable
181 :     for testing and development use.</p>
182 :     <p>For a recovery build, the map will need to be updated to include our
183 :     fixes. This can either be everything on the head in CVS, or just the
184 :     particular fixes we need. The former should only be done if no risky
185 :     changes have gone onto the head since the last (i.e., the failed) build
186 :     submission.</p>
187 :     </td>
188 :     <tr>
189 : dpollock 1.1 </tr>
190 :     </table>
191 :     </body>
192 :     </html>