Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Install Eclipse & Plugins

Eclipse Indigo (3.7)

Info

As of 4th April 2012 our SVN repository will be gradually migrated to GIT. The new Eclipse bundle is a general update of the previous Indigo-based bundle which now also contains EGit plugin, an Eclipse Team provider for the Git version control system. For any question concerning Eclipse and Git integration, please read the EGit User guide.
To know more about Git usage you can start by reading our wiki page

Note

There's a bug in Indigo (see also related Internally at Magnolia we would have liked to switch to Eclipse Indigo a long time ago but then preferred to stick to Helios due to the shortcomings caused by this still unresolved Indigo bug (see also related issue http://jira.magnolia-cms.com/browse/BUILD-72) . However, if for some reason you have to use Indigo, we found some workarounds you can read below.

  • m2e 1.0 known issue

Indigo introduces m2e (Maven 2 Eclipse) 1.0, which seems to cause some problems with plugins that are not "known" by m2e. This hits Magnolia with the setproperty Maven plugin. If you have m2e 1.0 installed you will likely get the following error upon importing a Maven project (i.e. a Magnolia module) into Eclipse: 

Warning

No marketplace entries found to handle Execution currentDate, in /pom.xml in Eclipse.  Please see Help for more information.

Image Removed

Choose to resolve the issue later and import the project.

Now, in the Eclipse Markers view you should get the following Maven error preventing the project from building (you should also receive some negligible warnings about m2e ignoring some plugin's goals):

Warning

Plugin execution not covered by lifecycle configuration: info.magnolia:maven-setproperty-plugin:1.1.1:set-property (execution: currentDate, phase: generate-resources)

To get rid of the error and proceed with project build you'll need to add the following snippet to the pluginManagement/plugins section of your project's pom.xml

...

<plugin>
<!--This plugin's configuration is used to store Eclipse m2e settings only. It has no influence on the Maven build itself. -->
<groupId>org.eclipse.m2e</groupId>
<artifactId>lifecycle-mapping</artifactId>
<version>1.0.0</version>
<configuration>
  <lifecycleMappingMetadata>
    <pluginExecutions>
      <pluginExecution>
        <pluginExecutionFilter>
          <groupId>info.magnolia</groupId>
          <artifactId>maven-setproperty-plugin</artifactId>
          <versionRange>[1.1.1,)</versionRange>
          <goals>
            <goal>set-property</goal>
          </goals>
        </pluginExecutionFilter>
        <action>
          <execute></execute>
        </action>
      </pluginExecution>
    </pluginExecutions>
  </lifecycleMappingMetadata>
</configuration>
</plugin>

which causes Eclipse to show an annoying error message on poms. Worry not, however, your IDE will work fine nonetheless. Read more below.

If you can access Magnolia's internal network, a preinstalled eclipse for Mac OS X(Cocoa 64) called eclipse-indigo-macosx-cocoa-64-egit.zip can be found at our file server under Product Development/Eclipse

There is also preinstalled eclipse for Linux-64b. It can also be found in Product Development/Eclipse folder. This version supports Git DVCS.

The eclipse-indigo-macosx-cocoa-64-egit.zip bundle was created on 10 April 2012 and consists of the following platform, plugins and related versions:

Image Added

Cloning a Git repo with EGit

Info

Before proceeding please read our Git Usage wiki page

  • Copy the URL for Git repo (i.e. ssh://git@git.magnolia-cms.com/testing.git)
  • Open the Git Repository Exploring perspective > right click on the left pane and choose Paste Repository Path or URI

Image Added

  • A dialog like the one below should pop up. Make sure to use the user git to connect

Image Added
(In case you have a passphrase set on your private key, you'll have to enter this in a next step)

  • m2e 1.0 known issue

Indigo introduces m2e (Maven 2 Eclipse) 1.0, which seems to cause some problems with plugins that are not "known" by m2e. This hits Magnolia with the setproperty Maven plugin. If you have m2e 1.0 installed you will likely get the following error upon importing a Maven project (i.e. a Magnolia module) into Eclipse: 

Warning

No marketplace entries found to handle Execution currentDate, in /pom.xml in Eclipse.  Please see Help for more information.

Image Added

Just choose to resolve the issue later and import the project.

For some background info and the ratio behind this new behaviour in m2e, please read:

http://wiki.eclipse.org/M2E_plugin_execution_not_covered

http://dev.eclipse.org/mhonarc/lists/m2e-users/thrd7.html starting at http://dev.eclipse.org/mhonarc/lists/m2e-users/msg00448.html

  • magnolia-empty-webapp configuration

The new version of Maven integration For WTP plugin, will create a /target/m2e-wtp folder and serve project resources from there. This may cause issues when choosing to serve modules without publishing them in the Servers configuration. To solve this,

  • go to project Properties -> Deployment Assembly
  • remove the m2e-wtp folder
  • add src/main/webapp folder and src/main/resources folders 

Your configuration should now look similar to that of the screenshot below.
Image Removed

Notice that when importing new modules which magnolia-empty-webapp depends on, the Deployment Assembly configuration will be automatically updated. In the example above, the magnolia-ui-admincentral module was imported after the magnolia-empty-webapp and is now directly served from the eclipse workspace instead of the local Maven repository jar.

Eclipse Helios (3.6)

Info

As of 4th April 2012 our SVN repository will be gradually migrated to GIT. The new Eclipse bundle is a general update of the previous Helios-based bundle which now also contains EGit plugin, an Eclipse Team provider for the Git version control system.
To know more about Git usage you can start by reading our wiki page

If you can access Magnolia's internal network, a preinstalled eclipse for Mac OS X(Cocoa 64) called eclipse-helios-macosx-cocoa-64-egit.zip can be found at our file server under Product Development/Eclipse

There is also preinstalled eclipse for Linux-64b called eclipse-helios-linux-64bit.zip. It can also be found in Product Development/Eclipse folder. This version supports Git DVCS.

The eclipse-helios-macosx-cocoa-64-egit.zip bundle was created on 3 April 2012 and consists of the following platform, plugins and related versions:

Image Removed

Cloning a Git repo with EGit

Info

Before proceeding please read our Git Usage wiki page

  • Copy the URL for Git repo (i.e. ssh://git@git.magnolia-cms.com/testing.git)
  • Open the Git Repository Exploring perspective > right click on the left pane and choose Paste Repository Path or URI

Image Removed

  • A dialog like the one below should pop up. Make sure to use the user git to connect

Image Removed
(In case you have a passphrase set on your private key, you'll have to enter this in a next step)

Install Eclipse (3.5)

Download the Java EE edition which includes WTP (web tool project).

Subversive (Subversion Plugin)

Install the plugin

  1. Help / Install New Software ..
  2. select: Galileo - http://download.eclipse.org/releases/galileo
  3. select: Collaboration/Subversive SVN Team Provider

Note: to get the latest stable version you will better use the project's url. I had to do that because eclipse started to block on startups otherwise.

Note: There seems to be a version conflict with Subversive.  If you look at the table showing the content of the eclipse-helios-macosx-cocoa-64.zip bundle (in a preceding section, above) you will notice that it includes Subclipse, not Subversive.  If you have problems with Subversive you might try Subclipse instead.  http://subclipse.tigris.org/update_1.6.x

Connectors
You also have to install a connector. Subversive will prompt you on the first usage.

  1. open "SVN Repository" perspective (Window -> Open perspective)
  2. select SVNKit 1.3
  3. proceed installation

Git (EGit Plugin)

Install the plugin

  1. Help / Install New Software ..
  2. Add... (to add a new site)
  3. http://download.eclipse.org/egit/updates
  4. select: Eclipse Git Team Provider/Eclipse EGit

Open the Git perspective

  1. Window -> Open perspective -> Other...
  2. select: Git Repository Exploring

Known problems

  • EGit is not accepting your ssh passphrase when pulling or pushing. (Related Bug Report).
    EGit doesn't use system-wide ssh, but JSch instead. It's a Java implementation of SSH2.
    Problem is, that JSch does not support private keys until ver. 0.1.44.

To install latest JSch to your eclipse press:

  1. Help / Install New Software
  2. Add... (to add a new site)
  3. http://download.eclipse.org/tools/orbit/downloads/drops/R20110523182458/repository/
  4. select: All Orbit Bundles / JSch
  • If still don't work, check out Preferences / General / Network Connections / SSH2 and verify, if it's using correct private key.

Maven integration (M2Eclipse)

Plugin

  1. Help -> Install New Software ..
  2. Add... (to add a new site)
  3. http://m2eclipse.sonatype.org/sites/m2e

WTP Integration

  1. Help -> Install New Software ..
  2. Add... (to add a new site)
  3. http://m2eclipse.sonatype.org/sites/m2e-extras
  4. select: Maven Integration for WTP

Subversive Integration

  1. Help -> Install New Software ..
  2. Add... (to add a new site)
  3. http://www.polarion.org/projects/subversive/download/integrations/update-site/
  4. select: Subversive Integration for M2Eclipse

FreeMarker IDE (optional)

Register the following URLs in Help / Software Updates

  1. http://download.jboss.org/jbosstools/updates/JBossTools-3.0.3.GA
  2. select: FreeMarker IDE

Any Edit (optional)

Used for tab to space transformations and other cleanup on save

  1. http://andrei.gmxhome.de/eclipse
  2. select: AnyEditTools

JIRA integration (optional)

...

Maven Repository

See Maven setup. Be sure to follow these steps first as else you'll not be able to checkout magnolia properly!

...