|
Last change
on this file since 36339 was 36202, checked in by taylor.smock, 12 months ago |
|
See #8269: Add initial Maven support to JMapViewer
This is largely 1-1 compatible with the targets of the ant build.xml file, with
some exceptions (see "Ant targets -> Maven targets" in CONTRIBUTING.md).
Please note that maven (by default) puts most generated data into the target
directory. This has been overridden for some targets.
For this commit, the following informational files were added:
- RELEASING.md: I got tired of looking up how to do a release for JMapViewer
- CONTRIBUTING.md: Just in case someone else wants to contribute to JMapViewer
|
|
File size:
1.7 KB
|
| Line | |
|---|
| 1 | # Contributing
|
|---|
| 2 | ## How to test
|
|---|
| 3 | * Unit tests: `mvn test`
|
|---|
| 4 | * Manual testing: `mvn compile exec:java -Dexec.mainClass=org.openstreetmap.gui.jmapviewer.Demo`
|
|---|
| 5 |
|
|---|
| 6 | ## How to report a bug
|
|---|
| 7 | Please open a ticket at [https://josm.openstreetmap.de/newticket?component=JMapViewer](https://josm.openstreetmap.de/newticket?component=JMapViewer).
|
|---|
| 8 |
|
|---|
| 9 | ## How to submit changes
|
|---|
| 10 | Open a ticket at [https://josm.openstreetmap.de/newticket?component=JMapViewer](https://josm.openstreetmap.de/newticket?component=JMapViewer).
|
|---|
| 11 | See [https://josm.openstreetmap.de/wiki/DevelopersGuide/PatchGuide](https://josm.openstreetmap.de/wiki/DevelopersGuide/PatchGuide) for how to create the patch file and submit it.
|
|---|
| 12 |
|
|---|
| 13 | ## Check patch conformance
|
|---|
| 14 | * `mvn validate`
|
|---|
| 15 | * `mvn checkstyle:checkstyle`
|
|---|
| 16 | * `mvn spotbugs:check` -- this should be done by `mvn validate` as well, but it
|
|---|
| 17 | wasn't possible at time of writing due to existing spotbugs bugs in JMapViewer.
|
|---|
| 18 |
|
|---|
| 19 | ## Ant targets -> Maven targets
|
|---|
| 20 | * `ant clean` -> `mvn clean`
|
|---|
| 21 | * `ant build` -> `mvn compile`
|
|---|
| 22 | * `ant test` -> `mvn test`
|
|---|
| 23 | * `ant svn_info` -> manual pom.xml editing or `mvn release:update-versions -DdevelopmentVersion=$(svn propget ReleaseVersion .)-SNAPSHOT`
|
|---|
| 24 | * `ant pack` -> `mvn package` (note: slightly different source filename, doesn't merge source and class jars)
|
|---|
| 25 | * `ant create_run_jar` -> not migrated (use `mvn exec:java -Dexec.mainClass="org.openstreetmap.gui.jmapviewer.Demo"` instead)
|
|---|
| 26 | * `ant spotbugs` -> `mvn spotbugs:check`
|
|---|
| 27 | * `ant checkstyle` -> `mvn checkstyle:checkstyle`
|
|---|
| 28 | * `ant javadoc` -> `mvn javadoc:javadoc`
|
|---|
| 29 | * `ant create_release_zip` -> `mvn jar:jar`
|
|---|
| 30 | * `ant create_source_release_zip` -> `mvn source:jar`
|
|---|
| 31 | * `ant checkdepsupdate` -> `mvn versions:display-dependency-updates` (note: please try to keep the version information in sync)
|
|---|
Note:
See
TracBrowser
for help on using the repository browser.
