Jenkins continuous integration server: Difference between revisions

← Older edit

Content deleted Content added

Inline

@@ Line 2: / 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. You can have a look at [http://stendhalgame.org/jenkins/ our Jenkins server] with several build jobs for Stendhal, Marauroa and Marboard.
+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==
-To install and run Jenkins you just need to download the jenkins.war from the Jenkins web site and have java ready. To start the server you need a small start script that issues the following command:
+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
-Once the 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):
+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
 If you see the Jenkins interface loading, you have successfully installed Jenkins.
 ==Configuration for Stendhal==
-To let Jenkins build stendhal you have to match the following prerequesites:
+To let Jenkins build Stendhal you have to match the following prerequisites:
 * 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-Client installed
+* Git installed
-For our Jenkins we installed several plugins 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.
+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.
+* [https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin Git Plugin]
+** 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: / Line 48: @@
 ==Setup a build job for Stendhal==
-The next steps show, how to configure a basic build job for stendhal.
+The next steps show how to configure a basic build job for Stendhal.
-===Source Code Management System===
+===Source Code Management===
-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 want to build HEAD.
+* Branches to build
+:* 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. Our current way of triggering builds is triggered from CVS at a certain time. This means not, the CVS tells Jenkins to start a build, but it tells Jenkins to check regularly the CVS for changes and builds, when there were commits since last build.
+Here you configure when a build is started. A possible way is triggering from Git at a certain time. This doesn't mean that Git tells Jenkins to start a build, but it tells Jenkins to check regularly on Git 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. 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.
-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 build.xml included in stendhal source code. We let Jenkins first call ''clean run_tests_with_cobertura''. This first cleans the workspace and starts a complete build including coverage measurement. Afterwards we start ''java_doc'' which generates a fresh api documentation from stendhal.
+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===
-After a build was successful certain steps follow to produce those nice looking reports and graphics. For stendhal we use several reports to publish.
+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 java docs
+:* check this option to publish the generated Java docs
 :* provide ''api'' as directory for the docs
-* junit test results
+* Publish JUnit test result report
 :* check this option to publish the results
-:* provide ''build/build_test_report/testresults.xml'' as location for the junit report in xml format
+:* 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
-:* provide ''build/cobertura_report/*.xml'' as report file
+:* provide <code>**/build/build_server</code> as ''Path to class directories''
+:* provide <code>**/src</code> as ''Path to source directories''
 * To do report
 * Warnings
-==Known Problems==

Jenkins continuous integration server: Difference between revisions

Navigation menu

Search