Reporting Issues

If something does not work as you expected, it is really frustrating. It is not good to have frustrated and unhappy users and we are doing our best to make them happy, but we need information. Information is a key to get your issue fixed. In order to fix issue, someone would have to reproduce it. You can start with describing problem in more details.

Here is an example or report template that you could fill in in order to give other readers enough information to help you:

• Details about your environment:
  • using Eclipse version 3.x and m2eclipse version 0.9.x (attach Eclipse configuration details from "Help / About Eclipse SDK / Configuration Details")
  • created project A in Eclipse workspace, here its pom.xml (attach corresponding pom.xml)
  • created project B in Eclipse workspace declares A as dependency, here
    its pom.xml (attach corresponding pom.xml)

• Details about your actions (Examples)
  • imported new Java project, selected Enable Maven action
  • run "Maven / Update Project Configuration" form popup menu on both
    projects A and B, or run "Maven / Update Dependencies" action, or run
    "Project / Clean" action, or run action "XYZ" on zyx.
  • from popup menu on project B used "Run as... / Java application" on
    class XYZ and got the following error/exception, etc.
  • command line for the failed process is also shown below/attached (see
    more details how to retrieve command line text for the failed process

• Details about actual errors or failed expectations (Examples)
  • after build is complete, "Problems" view (or "All Markers" view
    in Eclipse 3.4) and shows the following erros (attach error text copied using "Copy" action in Problems view)
  • during Maven build, the Maven console shows the following errors...
  • expected to see dependency XYZ, but it does not appear in "Maven Dependencies" claspath container
  • the "Error Log" view, that can be open from "Window / Show View / Error Log", or Alt+Shift+Q, L shortcut (or Eclipse log at <workspace>/.metadata/.log) shows the following exceptions (attach the error text including exception stack trace)

When you are importing project with already existing pom.xml, it could use various plugins, and failure can be caused by some of those plugins. You could help us by trying to isolate issue using the following steps:

• Check that Maven build pass from the command line (i.e. using 'mvn install' command)

• Check settings.xml (both user-level and global settings) and specify if you have any environment-specific info. For example: non-default location of the local repository, proxy configuration, profiles, repositories, mirrors, etc. You can also attach your settings.xml to the bug report.

• Try to create simple project in Eclipse and try to reproduce project structure by adding pieces from the failing project one by one. Once you reproduced issue in your test project you can zip it and attach to the issue you created in JIRA.
  • Attach log for the erroneous build from the Maven console (see Console view, or Alt+Shift+Q, C and then open "Maven Console" from the Console view toolbar) with debug output enabled (see Maven preferences at Window / Preferences... / Maven / Debug Output).
  • Attach Eclipse configuration details from Help / About Eclipse SDK / Configuration Details

To make it easier for us to import your projects we recommend the following conventions:

• Maven groupId - org.maven.ide.eclipse.projects

• Maven artifactId and Eclipse project name - MNGECLIPSE-XXX (use additional suffixes if you need more than one project)
  

  <project xmlns="http://maven.apache.org/POM/4.0.0"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.maven.ide.eclipse.projects</groupId>
    <artifactId>MNGECLIPSE-XXX</artifactId>
    <version>0.0.1</version>
    <packaging>jar</packaging>
    <name>MNGECLIPSE-XXX</name>
    <parent>
    	<groupId>org.maven.ide.eclipse.projects</groupId>
    	<artifactId>MNGECLIPSE-XXXparent</artifactId>
    	<version>0.0.1</version>
    	<relativePath>../MNGECLIPSE-XXXparent</relativePath>
    </parent>
    ...