Jump to: navigation, search

Difference between revisions of "Modeling Project Releng/Releng Module"

m (Template Variables)
m (add emft category)
Line 121: Line 121:
[[Category:Modeling]] [[Category:EMFT]] [[Category:Releng]]

Revision as of 14:37, 23 February 2007

Template Usage Steps

First, you need to get a copy of the template.

  1. For EMFT, copy /cvsroot/technology/org.eclipse.emft/releng/common_releng_template to org.eclipse.emft/releng/_SHORTNAME_, where _SHORTNAME_ = "cdo", "eodm", "jeteditor", etc.
  2. For Modeling, copy /cvsroot/modeling/releng-common/templates/org.eclipse._PROJECTNAMESPACE_.releng to /cvsroot/modeling/org.eclipse._PARENTPROJECTNAME_/org.eclipse._PROJECTNAMESPACE_.releng, where _PARENTPROJECTNAME_ = "mdt", "m2t", etc. _PROJECTNAMESPACE_ is defined below.
  3. Find and rename all files with _SHORTNAME_ in their name, using the project's shortname
    • promoteToEclipse._SHORTNAME_.properties
    • templateFiles/_SHORTNAME_.map.template
    • maps/_SHORTNAME_.map
  4. Find and replace all occurrences in all files of the string "_PARENTPROJECTNAME_" with your parent project's name.
  5. Find and replace all occurrences in all files of the string "_SHORTNAME_" with your project's shortname.
  6. Find and replace all occurrences in all files of the string "_PROJECTNAMESPACE_" with your project's namespace. This can be the same as the shortname, that is
         org.eclipse._PROJECTNAMESPACE_ -> org.eclipse.eodm

but is often different, including .emf or more
         org.eclipse._PROJECTNAMESPACE_ -> org.eclipse.emf.cdo

         - or -

         org.eclipse._PROJECTNAMESPACE_ -> org.eclipse.uml2.tools

         - or -

         org.eclipse._PROJECTNAMESPACE_ -> org.eclipse.emf.codegen.jet.editor

Customization Steps

Next, you need to customize the template for your project's specific needs.

1. Edit promoteToEclipse.*.properties: 
      enter the correct name / email address
      newsgroupPublisherEmail="My Name <me@mydomain.com>"
2. Edit repoInfo.properties: 
      enter the correct cvs username(s)
3. Edit buildAll.xml:
      ensure that if you are properly configured for the JDK you require (1.4, 5.0) (see TODOs)

   If this project depends on more than just Eclipse and EMF (eg., also on OCL) then enter
      more <replacefilter/> tags in target "publish" (see TODO)

   If necessary, you can manually copy files from the SDK into the other zips (see TODO)

   If necessary, you should remove 3rd party jars used at build time from the zips (see TODO)

   Additional changes may be required. For examples, see these projects:
      * JDK 1.4: eodm, jeteditor
      * JDK 5.0 and JDK 1.4: ocl, query, validation, transaction, jet 
          (5.0 used in 1.1/0.8 development streams, 
           1.4 used in 1.0/0.7 maintenance streams) 
      * JDK 5.0: cdo, net4j
4. Edit templateFiles/index.html.template: 
      ensure all requirements are listed in the Requirements table (see TODO)
5. Edit builder/*/build.properties: 
      ensure they are configured for the correct JDK version (see TODO)
6. Edit builder/*/customTargets.xml: 
      ensure all requirements are downloaded and unpacked as needed (see TODO)
      verify all namespaces are properly defined in -bundleDirectoryMatchRegex argument (see TODO)
7. Edit builder/tests/configs/local/customTest.xml: 
      ensure all requirements are downloaded and unpacked as needed (see TODO)
8. Edit builder/tests/configs/local/testing.properties: 
      ensure proper JDK and vmflags are set (see TODOs)
9. Edit builder/tests/scripts/runtests: 
      ensure proper JDK is set (see TODO)
      ensure proper J2SE15flags are set (see TODO)
10. Edit builder/tests/scripts/test.xml:
      ensure all requirements are downloaded and unpacked as needed (see TODO)
      ensure if your test plugin is jarred you (un)comment out the appropriate lines (see TODOs)

Doc Plugin Builder

For Modeling, there's a new template you can use to create the required stuff you need in your doc plugin in order to get at least javadoc (if you don't have any other documents available yet).

See releng-common/templates/org.eclipse._PROJECTNAMESPACE_.doc

For EMFT, look at an existing project such as EODM and compare their build/ and references/ folders to those in your doc plugin, along with your toc.xml.

See org.eclipse.emft/eodm/doc/org.eclipse.eodm.doc

Note that the Modeling template does not include images; if you're missing these, you can copy them from the EODM doc example.

Template Variables

This is a checklist of all the customizations required to move from generic template to custom implementation. Ideally, much of this could be replaced with an Eclipse-based Wizard.

  • JDK version (1.4, 5.0), $JAVA_HOME / $javaHome flags/variables, JVM option flags (-Xmx, -Xms...)
  • email name/address for newsgroup posts
  • files in SDK that need to be copied to runtime/examples for completeness, etc.
  • test plugin jarred/not-jarred
  • cvs username(s) (usually set to nickb; doesn't need to change)
  • included namespaces (usually just org.eclipse._PROJECTNAMESPACE_, but can include more -- see EMFT Transaction project, which includes .workspace as well as .transaction)
  • upstream dependencies (usually just Eclipse + EMF, but sometimes more)
  • 3rd party jars used only for building (but not publishable) (usually none)
  • additional extra customizations (if any)