DevGuide

evernat edited this page Apr 16, 2018 · 47 revisions

Nightly build, compilation and development of JavaMelody

Download nightly build

You can download the nightly build (snapshot from master), from CloudBees Jenkins CI. Built on CloudBees

Build Status

Browsing the sources and javadoc

You can browse the development sources from GitHub or you can download the source code zip file of a release which includes the sources of that release.

You can also browse the latest javadoc, sources and other reports from the CloudBees Jenkins CI (snapshot from trunk).

You can also browse the sources at grepcode with point and click, except that grepcode does not display the latest version in general.

Building from sources

The "Source code" zip file available in "Releases" contains the java sources with an ant script javamelody-core/build.xml and a javamelody-core/pom.xml file for maven. If you want to rebuild the development version and not a particular release, clone from https://github.com/javamelody/javamelody/

After decompressing the zip file or after the checkout, in the javamelody-core directory, you can use the "all" target of the ant script (without maven) to recompile from sources and to rebuild the javamelody.jar and javamelody.war files which are those available in "Releases". You must define the environment variable JAVA_HOME with the path of a JDK 1.7 to compile the sources.

For example:

<path_to_ant>/bin/ant -f <path_to_javamelody>/build.xml all

You can also use the maven goals "clean site" to build a maven site with documentations and reports on analysis of sources or on unit tests (checkstyle, findbugs, pmd, cpd, junit, cobertura). You will need Maven 3.0.4 or later for that.

Development

The development is done with Eclipse in its latest version and with the jdk 1.7 at least for compilation.

The manager of sources is GitHub at https://github.com/javamelody/javamelody/

The charset of files is UTF-8. The style guide is the google's style guide except for tab indentation. The Eclipse configuration is supplied in sources with the configuration of code formater, clean-up, warnings and of checkstyle, pmd, findbugs plugins. The infinitest eclipse plugin is also recommended.

The official languages of the project are french for javadoc but english for technical terms. (This provides a clean separation between functional and technical vocabulary, given that you speak French obviously).

The diagrams in the OpenOffice map or the other one may help to understand.

Tests

The JUnit tests can be launched with the "test" target of the ant script, or with maven or in ContinuousIntegration.

The manual tests are written in the OpenOffice Test plan.

Plugins

Other plugins

Release process

This is an internal reminder of the steps of the release process.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.