Re: [edt-dev] How to commit code to EDT

[David M Williams <david_williams@xxxxxxxxxx>]

I was going to give you a little reminder
or advice to be sure to put information like this in your EDT Wiki ...
but I could not find an EDT Wiki! Is there not one yet? If not, you can
see what some other projects have done under 

http://wiki.eclipse.org/Category:Tools_Project

or 

http://wiki.eclipse.org/Category:Eclipse_Web_Tools_Platform_Project

Its pretty free form. You could start
your pages with 
http://wiki.eclipse.org/EDT


The only thing to think about a little
is how you might want to "layout" your site hierarchy. such as
".../EDT/Builds" ".../EDT/CVS", ".../EDT/Designs"
[but, look at existing examples from other sites ... I'm not sure what
to advise for specifics ... just that it might help to have a plan, before
you create 50 pages, all under "EDT". 
The advantage of using "directory
notation"  is that it will give you some automatic breadcrumbs,
as you navigate deeper. You'll also see a lot of use of "categories"
... very handy for keeping things organized rather painlessly. 

If you haven't heard this yet, usually
the Wiki is the place to put "developer" or "committer"
information. The WWW pages, such as at http://www.eclipse.org/edt/

are seen more for "consumer"
information. The former being sort of dynamic, frequently changing, rough
notes, not polished, can be written/edited by anyone with a bugzilla ID,
where as the www pages take a little more work to add or change, have to
be a committer, must follow "Eclipse page guidelines", usually
want spelling/grammar  correct, , :)  (that is, polished) as
it is more the place new people from the community would get a first impression
of your project.  

Or ... maybe you do have an EDT Wiki
already and I just couldn't find it?

In either case, it is a nice place to
put committer "how to..." directions such as these you sent to
mailing list, as it'll be easier to find 3 months from now, as new committers
join up, or existing committers need to re-read for reference. 

And, its just a suggestion ... I know
there's a lot to drink in, and it'll take time to learn yet another new
thing. Can't go wrong with the mailing list .. it is always good. 

Now that I think about I should put
this note I've written on a wiki somewhere :) 

Just trying to help :) 






From:      
 Matthew Heitz/Raleigh/IBM@IBMUS
To:      
 edt-dev@xxxxxxxxxxx
Date:      
 02/25/2011 09:38 AM
Subject:    
   [edt-dev] How
to commit code to EDT
Sent by:    
   edt-dev-bounces@xxxxxxxxxxx

---

Hello EDT developers, 

This is Matt Heitz, a developer and committer for EDT.  I'm in the
process of setting up our builds.  I'm writing to explain how to get
your changes into a build.  All committers should read and understand
this note. 

Builds don't simply compile the latest code from CVS.  A special file
called a map file identifies the plugins to be built.  There's an
entry for each plugin naming the CVS tag for that plugin's code.  (A
CVS tag is simply a label on a particular version of a file.)  The
build will include the tagged files from each plugin in the map file.  This
means that to get a change into the build, you must commit your file to
CVS, put a new tag on it AND all of the other files in the plugin, and
update the map file with the new tag.  That's a lot of work, which
is why people have written a tool to automate most of the process.

The tool is in the org.eclipse.releng.tools plugin.  You can find
it by going to http://download.eclipse.org/eclipse/downloads
if you use Eclipse 3.6, or http://archive.eclipse.org/eclipse/downloads/index.php
if you use an older version of Eclipse.  Click on the link for the
release you're using and you'll find org.eclipse.releng.tools at the bottom
of the page.   
To install it, unzip it into your dropins folder and restart Eclipse.

You need to check out the org.eclipse.edt.releng plugin from CVS, because
it contains our map file.  (Releng is short for "release engineering".
 Most of the files that control EDT builds are in org.eclipse.edt.releng.)

To release a change into the build follow these steps:

1. Select all plugins that have uncommitted changes, and org.eclipse.edt.releng.

2. Right click (while on any selected plugin) and chose Team->Synchronize
with Repository.  This step makes sure you are getting the latest
map file and checks for any conflicts before you commit.

3. In the Team Synchronizing perspective, commit your changes and at the
same time update changes from other developers into your workspace.  Perform
merges if needed. 

4. Go back to the Java Perspective.  If there are any errors, correct
them and go back to step 1. 

5. With the same set of plugins from step 1 still selected, you are now
ready to Team-Release them.  Right click (while on any selected plugin)
and select Team->Release.... 

6. The Release wizard is displayed. Select "Specify the map project
you want to use" and select org.eclipse.edt.releng. Click Next.

7. The wizard displays the list of projects in your workspace that have
entries in the map file. In the Project Selection Dialog, verify that the
plugins with your changes are checked in the Project Selection dialog.
 Click Next. 

8. Specify a release tag for your changes. Your project(s) will be tagged
with this tag and the map file will be updated with it as well. The format
of a tag should be 'v' followed by a timestamp in YYYYMMDDHHMM format,
using 00 to 23 for the hour.  For example, the tag for changes made
on December 21st 2012, at 11:59pm is v201212212359.  The timestamp
must be in the Eastern U.S. timezone.  If you're located elsewhere,
go to http://www.timeanddate.com/worldclock/city.html?n=179
for the current time in New York. 

9. The next page allows you to view the changes to the map file. Click
Next. 

10. Enter a commit comment on the last page of the wizard. Click Finish.

Note: do not use Team->Release if you're making changes to org.eclipse.edt.releng.

Once I've got them configured properly, our Nightly builds run at 9 PM
Eastern U.S. time. 

Please let me know if you have any questions. 

-Matt 
_______________________________________________
edt-dev mailing list
edt-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/edt-dev