Jenkins continuous integration server: Difference between revisions
Jump to navigation
Jump to search
Content deleted Content added
imported>Balaur →Source Code Management System: file system |
imported>AntumDeluge add note |
||
| (6 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
{{Navigation for Stendhal Developers}} |
{{Navigation for Stendhal Developers}} |
||
'''''NOTE:''' the project no longer used Jenkins'' - [[User:AntumDeluge|AntumDeluge]] ([[User talk:AntumDeluge|talk]]) |
|||
Jenkins is an extensible continuous integration server. |
Jenkins is an extensible continuous integration server. Some developers use local Jenkins instances for building Stendhal and Marauroa. |
||
<div style="border: 1px solid red; padding: 1em">The rest of this article deals with the installation and configuration of Jenkins. If you are just interested in the results, please follow this link to [http://stendhalgame.org/jenkins/ our Jenkins server] above. |
|||
</div> |
|||
In production we don't use Jenkins, but [https://travis-ci.org/arianne/ Travis]. |
|||
==Installation== |
==Installation== |
||
To install and run Jenkins you just need to download the jenkins.war from the Jenkins web site and have |
To install and run Jenkins you just need to download the <code>jenkins.war</code> from the Jenkins web site and have Java ready. To start the server you need a small start script that issues the following command: |
||
java -jar jenkins.war |
java -jar jenkins.war |
||
Once |
Once Jenkins is started, you can reach the user interface via your favourite browser if you open the following URL (assuming you have Jenkins on the same machine as your browser): |
||
http://localhost:8080 |
http://localhost:8080 |
||
If you see the Jenkins interface loading, you have successfully installed Jenkins. |
If you see the Jenkins interface loading, you have successfully installed Jenkins. |
||
==Configuration for Stendhal== |
==Configuration for Stendhal== |
||
To let Jenkins build |
To let Jenkins build Stendhal you have to match the following prerequisites: |
||
* ANT installed on the same system |
* ANT installed on the same system |
||
* JDK 7 installed |
|||
* JDK1.5 installed (already matched if you were successfully running Jenkins, as it needs java to run) |
|||
* |
* Git installed |
||
Here is a list of Jenkins plugins that you may want to install via the Jenkins configuration. You can see what each plugin does, if you have a look at onto the wiki at the Jenkins homepage. |
|||
| ⚫ | |||
** if you want to build from a Git repository |
|||
* [https://wiki.jenkins-ci.org/display/JENKINS/File+System+SCM File System SCM Plugin] |
|||
** if you want to build directly from the working copy (without committing) |
|||
* [https://wiki.jenkins-ci.org/display/JENKINS/Xvnc+Plugin Xvnc Plugin] |
|||
** You may want to install this if some tests that depend on Swing fail with an error like ''«No X11 DISPLAY variable was set, but this program performed an operation which requires it»'' (see http://stackoverflow.com/q/12533339/479288). |
|||
Other plugins to try: |
|||
* [http://wiki.jenkins-ci.org/display/JENKINS/Audit+Trail+Plugin Audit Trail] |
* [http://wiki.jenkins-ci.org/display/JENKINS/Audit+Trail+Plugin Audit Trail] |
||
* [http://wiki.jenkins-ci.org/display/JENKINS/Checkstyle+Plugin Checkstyle Plugin] |
* [http://wiki.jenkins-ci.org/display/JENKINS/Checkstyle+Plugin Checkstyle Plugin] |
||
| ⚫ | |||
<!--* [http://jenkins.gotdns.com/wiki/display/JENKINS/Crap4J+Plugin Jenkins Crap4J plugin]--> |
<!--* [http://jenkins.gotdns.com/wiki/display/JENKINS/Crap4J+Plugin Jenkins Crap4J plugin]--> |
||
<!--* [http://wiki.jenkins-ci.org/display/JENKINS/Emma+Plugin Jenkins Emma plugin]--> |
<!--* [http://wiki.jenkins-ci.org/display/JENKINS/Emma+Plugin Jenkins Emma plugin]--> |
||
| Line 43: | Line 48: | ||
==Setup a build job for Stendhal== |
==Setup a build job for Stendhal== |
||
The next steps show |
The next steps show how to configure a basic build job for Stendhal. |
||
===Source Code Management |
===Source Code Management=== |
||
==== Build from |
==== Build from Git ==== |
||
To build from |
To build from Git, you need to have the [https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin Git plugin] installed. Just select Git and configure the following parameters: |
||
* Repository URL |
|||
* CVS-Root |
|||
:* <code>file:///your/path/to/stendhal</code> |
|||
:* :pserver:anonymous@arianne.cvs.sourceforge.net:/cvsroot/arianne |
|||
* Branches to build |
|||
* Module |
|||
| ⚫ | |||
:* stendhal |
|||
* Branch |
|||
| ⚫ | |||
:* or choose a branch name to build |
:* or choose a branch name to build |
||
| Line 66: | Line 69: | ||
===Build Trigger=== |
===Build Trigger=== |
||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
For both of this options you have to provide a cron like notation, when to check/build. At the moment, we check every day at 5 am and build then. |
|||
For both of this options you have to provide a cron like notation, when to check/build. For example, you could check every day at 5 am and build then. |
|||
===Build Steps=== |
===Build Steps=== |
||
To build Stendhal with Jenkins, we just execute three targets from the standard build.xml included in |
To build Stendhal with Jenkins, we just execute three targets from the standard <code>build.xml</code> included in Stendhal source code. We let Jenkins first call <code>clean test</code>. This first cleans the workspace and starts a complete build including coverage measurement. Afterwards we start <code>docs</code> which generates a fresh API documentation from Stendhal. |
||
===Post Build Processing=== |
===Post Build Processing=== |
||
After a build was successful certain steps follow to produce those nice looking reports and graphics. For |
After a build was successful certain steps follow to produce those nice looking reports and graphics. For Stendhal we use several reports to publish. |
||
* Publish Javadoc |
|||
* java doc |
|||
:* check this option to publish the generated |
:* check this option to publish the generated Java docs |
||
:* provide ''api'' as directory for the docs |
:* provide ''api'' as directory for the docs |
||
* |
* Publish JUnit test result report |
||
:* check this option to publish the results |
:* check this option to publish the results |
||
:* provide |
:* provide <code>**/build/build_test_report/testresults.xml</code> as location for the JUnit report in XML format |
||
* Record JaCoCo coverage report |
|||
* cobertura |
|||
:* this option allows us to publish the results of the test coverage |
:* this option allows us to publish the results of the test coverage |
||
:* provide |
:* provide <code>**/build/build_server</code> as ''Path to class directories'' |
||
:* provide <code>**/src</code> as ''Path to source directories'' |
|||
* To do report |
* To do report |
||
* Warnings |
* Warnings |
||
==Known Problems== |
|||