Skip to main content
Jump to: navigation, search

Difference between revisions of "JWT DeveloperFAQ"

m (Installing JWT Source Code from CVS)
(Releasing the Workflow Editor)
Line 28: Line 28:
 
==== 1. Preparing ====
 
==== 1. Preparing ====
  
* Make sure the copyright/year information in the Java headers is up to date
+
* Make sure the ''copyright/year information in the Java headers'' is up to date
* Synchronize plugin*.properties translations for all languages
+
* ''Synchronize plugin*.properties'' translations for all languages
* Remove unneccessary plugin dependencies using the ''Plugin.xml''-editor
+
* ''Remove unneccessary plugin dependencies'' using the ''Plugin.xml''-editor
* Make sure the description of the JWT extension points is up to date
+
* Make sure the ''description of the JWT extension points'' is up to date
* Close finished Bugzilla tasks and move open ones to the next release (create bugzilla version tag for the next release if not already present)
+
*'' Close finished Bugzilla tasks'' and ''move open ones'' to the next release (create bugzilla version tag for the next release if not already present)
* Update the internal documentation in JWT-WE (about.txt, package.html)
+
* ''Update the internal documentation'' in JWT-WE (e.g. README, abouttext.txt, about.html, the package.html files in each Java package...)
* Make sure the internal version of the Workflow Editor and all its plugins is set to the new release version
+
* Make sure the ''internal version of the Workflow Editor and all its plugins'' is set to the new release version
* The converter must be updated to the newest file format
+
* The ''converter'' must be updated to the newest file format
* Ensure that all keybindings for Eclipse commands (menu/toolbar) are set correctly
+
* Ensure that all ''keybindings for Eclipse commands'' (menu/toolbar) are set correctly
* Make sure the licence information is valid
+
* Make sure the ''licence information'' is valid (notice.html)
* The internal readme file must be up to date
+
 
* Update the release notes
 
* Update the release notes
  
 
==== 2. Generating Packages ====  
 
==== 2. Generating Packages ====  
  
* Generate new Javadocs for each component to be released
+
* Generate new ''Javadocs'' for each component to be released
* Generate a release package and a source package for the Workflow Editor
+
* Generate a release package and a source package for the ''Workflow Editor''
* Generate a release package and a source package for the WE View Creator
+
* Generate a release package and a source package for the ''WE View Creator''
* Generate release and source packages for all WE Plugins
+
* Generate release and source packages for ''all WE Plugins''
* Update the example processes and create a ZIP archive
+
* Update the ''example processes'' and create a ZIP archive
* Sign packages
+
* ''Sign packages''
  
 
==== 3. Deploying ====  
 
==== 3. Deploying ====  
  
* Tag the release state of the Workflow Editor and the Plugins on the CVS as a new version (e.g. v040)
+
* ''Tag the release state'' of the Workflow Editor, View Creator and the Plugins on the CVS as a new version (e.g. v040)
* Archive old release (move to archive.eclipse.org) and upload new release packages to the download server (in a new directory with subdirectories for plugins and documentation)
+
* ''Archive old release'' (move files to "archive.eclipse.org") and ''upload new release packages'' to the download server "download.eclipse.org" (in a new directory with subdirectories for plugins and documentation)
* Update the links of archived and new downloads on the wiki download page ([[JWT_Downloads| Downloads]]) and related Wiki pages
+
* ''Update the links'' of archived and new downloads on the wiki download page ([[JWT_Downloads| Downloads]]) and related Wiki pages
* Update the Eclipse JWT page (entry for the news section, direct download link for the Workflow Editor, direct download link for documentation, project pages, ...)
+
* ''Update the Eclipse JWT page'' (add an entry to the news section, adapt direct download link for the Workflow Editor and direct download link for documentation, update project pages, ...)
* Adapt the feature in the JWT Eclipse Update Site
+
* Adapt the feature in the ''JWT Eclipse Update Site'' for automatic download
* Notify Mailing List
+
* ''Notify Mailing List and partners''
  
 
----
 
----

Revision as of 12:06, 29 July 2008

Frequently Asked Questions for Developers

Installing JWT Source Code from CVS

For information on how to access the JWT source code, the layout of the CVS repositories and the dependencies of JWT components, please refer to JWT CVS Information. For write access to the CVS you need to replace the anonymous access with your Eclipse committer account data.

Internal Layout of the JWT Source Code

Workflow Editor

  • ToDo

How to Extend/Modify JWT

Extending the Workflow Editor

The article Extending JWT-WE contains information on how JWT can be extended by user-defined plugins that provide e.g. external actions or additional views.

Modifying the Workflow Editor

The article Modifying JWT-WE provides information on how several recurring tasks (like adding preferences to the preferences menu) can be accomplished.

How to prepare a new Release

Releasing the Workflow Editor

1. Preparing

  • Make sure the copyright/year information in the Java headers is up to date
  • Synchronize plugin*.properties translations for all languages
  • Remove unneccessary plugin dependencies using the Plugin.xml-editor
  • Make sure the description of the JWT extension points is up to date
  • Close finished Bugzilla tasks and move open ones to the next release (create bugzilla version tag for the next release if not already present)
  • Update the internal documentation in JWT-WE (e.g. README, abouttext.txt, about.html, the package.html files in each Java package...)
  • Make sure the internal version of the Workflow Editor and all its plugins is set to the new release version
  • The converter must be updated to the newest file format
  • Ensure that all keybindings for Eclipse commands (menu/toolbar) are set correctly
  • Make sure the licence information is valid (notice.html)
  • Update the release notes

2. Generating Packages

  • Generate new Javadocs for each component to be released
  • Generate a release package and a source package for the Workflow Editor
  • Generate a release package and a source package for the WE View Creator
  • Generate release and source packages for all WE Plugins
  • Update the example processes and create a ZIP archive
  • Sign packages

3. Deploying

  • Tag the release state of the Workflow Editor, View Creator and the Plugins on the CVS as a new version (e.g. v040)
  • Archive old release (move files to "archive.eclipse.org") and upload new release packages to the download server "download.eclipse.org" (in a new directory with subdirectories for plugins and documentation)
  • Update the links of archived and new downloads on the wiki download page ( Downloads) and related Wiki pages
  • Update the Eclipse JWT page (add an entry to the news section, adapt direct download link for the Workflow Editor and direct download link for documentation, update project pages, ...)
  • Adapt the feature in the JWT Eclipse Update Site for automatic download
  • Notify Mailing List and partners

Releasing the AgilPro LiMo/Simulator

  • update release notes
  • update tutorial
  • update javadoc
  • update howtos
  • update install informations
  • valid licence in installer?
  • valid update splashscreen?
  • copy emf model to simulator
  • convert sample processes
  • test installer for all operating system versions
  • SVN: branch, javadocs
  • CVS: tag version
  • mylyn: close finished bugs, move open ones to next release

Preparing

Generating Packages

Deploying

Eclipse Maintenace Stuff

Putting Files on the Download Server

  • Old files should be moved to archive.eclipse.org:
    • ssh yourcommitterid@dev.eclipse.org
    • mv ~/downloads/your/project/oldrelease/ /home/data/httpd/archive.eclipse.org/your/project/oldrelease/
  • Connect to download1.eclipse.org using SCP/SFTP and upload the new files
  • Update the JWT Download Site
  • Update the main JWT site (news area, download area)

Updating the Web Site

  • Connect to the CVS repository /cvsroot/org.eclipse on dev.eclipse.org
  • The files concerning the JWT page are in the directory /www/jwt
  • Refer to http://www.eclipse.org/phoenix/ for information on how to set up the pages

Adapting the Eclipse Update Site

  • ToDo

See also

Copyright © Eclipse Foundation, Inc. All Rights Reserved.