Arianne

Jenkins continuous integration server: Difference between revisions

← Older edit
Content deleted Content added
VisualWikitext
imported>Hendrik Brummermann
renamed Hudson to Jenkins
imported>AntumDeluge
add note
 
(17 intermediate revisions by 3 users not shown)
Line 2:
{{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. YouSome candevelopers haveuse a look at [http://stendhalgame.org/jenkins/ ourlocal Jenkins server]instances withfor several build jobs forbuilding Stendhal, Marauroa and MarboardMarauroa.
 
 
<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==
To install and run Jenkins you just need to download the <code>jenkins.war</code> from the Jenkins web site and have javaJava ready. To start the server you need a small start script that issues the following command:
java -jar jenkins.war
Once the jenkinsJenkins 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
If you see the Jenkins interface loading, you have successfully installed Jenkins.
 
==Configuration for Stendhal==
To let Jenkins build stendhalStendhal you have to match the following prerequesitesprerequisites:
* 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)
* CVS-ClientGit installed
 
ForHere ouris Jenkinsa welist installedof severalJenkins plugins that you may want to install via the Jenkins configuration. You can see what each plugin does, if you have a look at our Jenkins or look onto the wiki at the Jenkins homepage. This list is not complete, as we still experiment with some of the plugins.
* [httphttps://wiki.jenkins-ci.org/display/JENKINS/CoberturaGit+Plugin JenkinsGit Cobertura pluginPlugin]▼
** 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/Checkstyle+Plugin Checkstyle Plugin]
▲* [http://wiki.jenkins-ci.org/display/JENKINS/Cobertura+Plugin Jenkins Cobertura 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]-->
Line 43 ⟶ 48:
==Setup a build job for Stendhal==
 
The next steps show, how to configure a basic build job for stendhalStendhal.
 
===Source Code Management System===
 
Just select CVS and configure the following parameters:
==== Build from Git ====
* CVS-Root
 
:* :pserver:anonymous@arianne.cvs.sourceforge.net:/cvsroot/arianne
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:
* Module
* Repository URL
:* stendhal
:* <code>file:///your/path/to/stendhal</code>
* Branch
:* leave this empty if you wantBranches to build HEAD.
:* leave this empty if you want to build HEAD.
:* or choose a branch name to build
 
==== Build from the working copy ====
 
To build from the working copy:
* have the [https://wiki.jenkins-ci.org/display/JENKINS/File+System+SCM File System SCM] plugin installed
* select "File System" from "Source Code Management"
* Path: <code>/your/path/to/stendhal</code>
 
===Build Trigger===
 
Here you configure, when a build is started. OurA currentpossible way ofis triggering builds is triggered from CVSGit at a certain time. This meansdoesn't not,mean thethat CVSGit tells Jenkins to start a build, but it tells Jenkins to check regularly theon CVSGit for changes and builds, when there were commits since the last build.
 
You also can start build at certain times not regarding changes since last build.
 
For both of this options you have to provide a cron like notation, when to check/build. AtFor the momentexample, weyou could check every day at 5 am and build then.
 
The other options allow it to start a build via URL or let a build start, if another build was finished.
 
===Build Steps===
To build Stendhal with Jenkins, we just execute three targets from the standard <code>build.xml</code> included in stendhalStendhal source code. We let Jenkins first call ''<code>clean run_tests_with_cobertura''test</code>. This first cleans the workspace and starts a complete build including coverage measurement. Afterwards we start ''java_doc''<code>docs</code> which generates a fresh apiAPI documentation from stendhalStendhal.
 
===Post Build Processing===
After a build was successful certain steps follow to produce those nice looking reports and graphics. For stendhalStendhal we use several reports to publish.
* Publish Javadoc
* java doc
:* check this option to publish the generated javaJava docs
:* provide ''api'' as directory for the docs
* junitPublish JUnit test resultsresult report
:* check this option to publish the results
:* provide ''<code>**/build/build_test_report/testresults.xml''</code> as location for the junitJUnit report in xmlXML format
* Record JaCoCo coverage report
* cobertura
:* this option allows us to publish the results of the test coverage
:* provide ''<code>**/build/cobertura_reportbuild_server</*.xmlcode> as ''Path asto reportclass filedirectories''
:* provide <code>**/src</code> as ''Path to source directories''
* To do report
* Warnings
 
==Known Problems==
Retrieved from "https://meet.konsthol.eu/w/index.php?title=Jenkins_continuous_integration_server"