Building a software project

Hudson can be used to perform the typical build server work, such as doing continuous/official/nightly builds, run tests, or perform some repetitive batch tasks. This is called "free-style software project" in Hudson.

Setting up the project

Go to Hudson top page, select "New Job", then choose "Build a free-style software project". This job type consists of the following elements:

  • optional SCM, such as CVS or Subversion where your source code resides.
  • optional triggers to control when Hudson will perform builds.
  • some sort of build script that performs the build (ant, maven, shell script, batch file, etc.) where the real work happens
  • optional steps to collect information out of the build, such as archiving the artifacts and/or recording javadoc and test results.
  • optional steps to notify other people/systems with the build result, such as sending e-mails, IMs, updating issue tracker, etc.

For more details, click the icons in the configuration page.

Hudson Set Environment Variable
Hudson sets some environment variables that are available to shell scripts, Windows batch files, Ant and Maven1 files that are executed by Hudson. A list of environment variables and how they are used are shown below.

Builds for Non-Source Control Projects

There is sometimes a need to build a project simply for demonstration purposes or access to a SVN/CVS repository is unavailable. By choosing to configure the project  as "None" under "Source Code Management" you will have to:

  1. Build the Project at least once, (it will fail), but Hudson will create the structure hudson/jobs/PROJECTNAME/workspace
  2. Copy the project files to hudson/jobs/PROJECTNAME/workspace
  3. Build again and configure appropriately

Hudson Set Environment Variables

When a Hudson job executes, it sets some environment variables that you may use in your shell script, batch command, Ant script or Maven POM 1. The following table contains a list of all of these environment variables.

Environment Variable Description
BUILD_NUMBER The current build number, such as "153"
BUILD_ID The current build id, such as "2005-08-22_23-59-59" (YYYY-MM-DD_hh-mm-ss)
JOB_NAME Name of the project of this build. This is the name you gave your job when you first set it up. It's the third column of the Hudson Dashboard main page.
BUILD_TAG String of hudson-${JOBNAME}-${BUILD_NUMBER}. Convenient to put into a resource file, a jar file, etc for easier identification.
EXECUTOR_NUMBER The unique number that identifies the current executor (among executors of the same machine) that's carrying out this build. This is the number you see in the "build executor status", except that the number starts from 0, not 1.
JAVA_HOME If your job is configured to use a specific JDK, this variable is set to the JAVA_HOME of the specified JDK. When this variable is set, PATH is also updated to have $JAVA_HOME/bin.
WORKSPACE The absolute path of the workspace.
SVN_REVISION For Subversion-based projects, this variable contains the revision number of the module. If you have more than one module specified, this won't be set.
CVS_BRANCH For CVS-based projects, this variable contains the branch of the module. If CVS is configured to check out the trunk, this environment variable will not be set.

Shell Scripts and Windows Batch Commands

If you're using a shell script to do your build, you can either put these environment variables directly into your shell scripts, or call them as parameters in your shell script. Below is an example how this can be done:

If you are executing a Windows Batch Command, the variables should be referenced using the %VARIABLE_NAME% pattern. For example:



Ant Scripts

If you're using an Ant script to do your build, you may include environment variables in property settings. Click on the Advanced... button just below where you put the Ant targets you want to build. This will display the Properties box. Below is an example how to use the Properties box to set Ant properties with Hudson Environment variables:

As an alternative, you can use the Environmental prefix to pull in all environmental variables as properties right inside your build.xml file. Below is an example how to set the property "label" to include the Project Name and the Build Number:

<property environment="env"/>
<property name="label" value="${env.JOB_NAME}-${env.BUILD_NUMBER}"/>

Configuring automatic builds

Builds in Hudson can be triggered periodically (on a schedule, specified in configuration), or when source changes in the project have been detected, or they can be automatically triggered by requesting the URL:

http://YOURHOST/hudson/job/PROJECTNAME/build

This allows you to hook Hudson builds into a variety of setups. For more information (in particular doing this with security enabled), see Remote access API.

Builds by changes in Subversion/CVS

To perform builds whenever someone makes a change in the repository, use a post-commit hook (hooks/post-commit for subversion, CVSROOT/loginfo for CVS) to trigger a new build. The hook can use wget/curl to access the build URL shown above, or send email to trigger a build as described below. The trigger may use /polling instead of /build at the end of the URL to make Hudson poll the SCM for changes rather than building immediately. This prevents Hudson from running a build with no relevant changes for commits affecting modules or branches that are unrelated to the job. When using /polling the job must be configured for polling, but the schedule can be empty.
Or, you could configure Hudson to poll your source control system periodically and start new builds when the changes have been detected.

Builds by e-mail (sendmail)

If you have the root account of your system and you are using sendmail, I found it the easiest to tweak /etc/aliases and add the following entry:

hudson-foo: "|/bin/wget -o /dev/null http://YOURHOST/hudson/job/PROJECTNAME/build"

and then run "newaliases" command to let sendmail know of the change. Whenever someone sends an e-mail to "hudson-foo@yoursystem", this will trigger a new build. See this for more details about configuring sendmail.

Builds by e-mail (qmail)

With qmail, you can write /var/qmail/alias/.qmail-hudson as follows:

|/bin/wget -o /dev/null http://YOURHOST/hudson/job/PROJECTNAME/build"

1 Maven requires that you include the parameter as part of the build goals.
Example Hudson configuration for the Maven "Goals" field: clean install -DBUILD_NUMBER=${BUILD_NUMBER}

Labels:

Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.
  1. Feb 11, 2008

    Anonymous says:

    I am using the $ Unknown macro: {BUILD_NUMBER} notation in a maven build succes...

    I am using the $

    Unknown macro: {BUILD_NUMBER}

    notation in a maven build successfully.

    
    

    mvn -Dbuild.id=$

    clean install

    
    
  2. Feb 27, 2008

    Anonymous says:

    You can reference Hudson variables as any other property when building with Mave...

    You can reference Hudson variables as any other property when building with Maven2.

    Hudson version 1.184

  3. Feb 27, 2008

    Anonymous says:

    I am using Hudson 1.44, and I have two versions of JDK installed: 1.4 ...

    I am using Hudson 1.44, and I have two versions of JDK installed: 1.4 and 1.6. Some projects I need to build in 1.4 and others in 1.6. I created two JDK instances in Hudson in the configuration file (config.xml):

    <jdk>
          <name>jdk 1.4</name>
          <javaHome>C:\j2sdk1.4.2_12</javaHome>
        </jdk>
        <jdk>
          <name>jdk 1.6</name>
          <javaHome>C:\jdk1.6.0_04</javaHome>
        </jdk>

    Inside of my project definition, I select jdk 1.6, and I set the Ant build command in the following way:  

    -DJAVA_HOME=C:\jdk1.6.0_04 -DPATH=C:\jdk1.6.0_04\bin

    Unfortunately, when I build I get the following error:

     [javac] C:\hudson\jobs\<project>\workspace\<class>.java:18: cannot access java.lang.Object
        [javac] bad class file: C:\jdk1.6.0_04\jre\lib\rt.jar(java/lang/Object.class)
        [javac] class file has wrong version 49.0, should be 48.0
        [javac] Please remove or make sure it appears in the correct subdirectory of the classpath.
        [javac] private String text;
        [javac]                 ^
        [javac] 1 error

    What am I doing wrong?

  4. Mar 28, 2008

    InstallGal says:

    Hello,  Is there a way to customize the BUILD_NUMBER value?  (ie. pa...

    Hello,

     Is there a way to customize the BUILD_NUMBER value?  (ie. padded 0's)

    Also, how can I reset this value to 1 after doing a few test builds?

     
    Thanks,

    Bila

    1. Jul 08, 2008

      Mark K says:

      I was able to do this by updating the number in nextBuildNumber text file inside...

      I was able to do this by updating the number in nextBuildNumber text file inside of the jobs directory (and all sub-projects), and then bouncing the hudson server.

  5. Jun 27, 2008

    Adam says:

    Hi,  what is the value of BUILD_ID in case of triggering builds by schedul...

    Hi, 

    what is the value of BUILD_ID in case of triggering builds by scheduled "Poll SCM" . Because it looks like this variable keeps time of starting "scanning" not the time of build (at least value of BUILD_ID is different than the name of folder with particaular build in build history). Could somebody help me?

    Thanks,

    Adam 

  6. Sep 08, 2008

    Amit says:

    Hi I am unable to customize my build process number ? I want to set my build n...

    Hi

    I am unable to customize my build process number ?

    I want to set my build number as TMT-100 so that when i trigger the build next time it becomes TMT-101,

    updating the number in nextBuildNumber is not effective for me.

    can anyone help me out of this issue.

    Thanks

    Anand

  7. Sep 16, 2008

    Rex Morrey says:

    We are using Hudson to manage a bunch of custom builds and like the quickness af...

    We are using Hudson to manage a bunch of custom builds and like the quickness afforted by Hudson in configuring a build. One of the issues we are trying to resolve is when there are two different branches involved in producing a build.  For example, many of our products use a common library, and occasionally a new branch of that common library is needed, along with the branch of a module (different modules).  It appears that Hudson's CVS setup only allows us to identify one branch, when what we need is a second CVS setup to identify an additonal branch. 

    Does anyone know how to handle such a situation?

  8. Apr 08, 2009

    Clement MAHE says:

    Hi  Does Hudson accept SVN Read-only repository ? Because i have some probl...

    Hi 
    Does Hudson accept SVN Read-only repository ? Because i have some problems to configure it.

    In fact i can make update in command line but when i try to enter credential, it indicate that kind of message :

    "FAILED: svn: OPTIONS of '/svn/projectname/trunk': 403 Forbidden (http://servername:serverport)"

    With same repository url and same account of course.

    Thanks

  9. Apr 15, 2009

    will thai says:

    Hi  I have a problem when using the 'use update' checkbox.  I need to...

    Hi

     I have a problem when using the 'use update' checkbox.  I need to have it unchecked to ensure a clean environment.

     The project I'm building generates files that is owned by 'root'.  So when hudson tries to deletes these files, the build fails.

     How do I fix this problem?

    thanks.

  10. Jun 12, 2009

    fabrice says:

    Hi I am trying to develop a post-commit svn hook script in order to run hudson ...

    Hi

    I am trying to develop a post-commit svn hook script in order to run hudson build but it is a hard task !

    It would be a good idea to write on the wiki a such script in order to avoid to lose time writting it

    Here my incomplete scrip (I have to find a way to get the projectName because REPOS is only ther path of the repo -..., maybe see svnlook changed -r $REV)

    REPOS="$1"
    REV="$2"

    HUDSON_URL="http://tl-em-1:8080/hudson/#PROJECT#/build?token=BUILD_ALMERYS_JOB"

    oldIFS=$IFS
    IFS="/"
    Array=( $REPOS )
    IFS=$oldIFS

    LastElementIndex=$

    Unknown macro: {#Array[@]}

    -1

    ProjectName=$

    Unknown macro: {Array[$LastElementIndex]}

    HUDSON_URL=$( echo "$HUDSON_URL" | sed s/#PROJECT#/$ProjectName/g )

    echo $REPOS >> /tmp/commit.txt

    /usr/bin/wget -o /dev/null "$HUDSON_URL"

  11. Jan 08, 2010

    Jus says:

    what is the variable that stores user who initiated build in hudson. This is so ...

    what is the variable that stores user who initiated build in hudson.
    This is so that to the email that is sent from hudson it can have who initiated build in hudson..

    Thanks in advance....

    1. Aug 24, 2010

      Curtis Pendleton says:

      Did you ever figure this out?  I displayed out all environment variables wh...

      Did you ever figure this out?  I displayed out all environment variables when my job ran and the user name is not in there.  Was you able to figure out a different way of getting the user into ant?

  12. Mar 19, 2010

    Martin Kropp says:

    Hi, I've been using Hudson for a while for very simple projects. Now we are wor...

    Hi,

    I've been using Hudson for a while for very simple projects. Now we are working on a larger web-portal project which has a recursive project structure.

    In the project root we have a "master" build.xml which calls all concrete subprojects' build.xml files.

    e.g.

    proj-root/build-app/builld.xml - here is the master build

    proj/app/firstapp/build/build.xml - here is build file of the Eclipse project firsapp

    How do I have to setup this in Hudson?

    Thank's a lot for your help.

    Martin

  13. May 18, 2010

    tim bogatchev says:

    Is the console output saved anywhere ? If so, which directory?

    Is the console output saved anywhere ?
    If so, which directory?

    1. May 18, 2010

      Rex Morrey says:

      The logs are stored in the C:/Documents and Settings/.hudson/jobs/<job name&g...

      The logs are stored in the C:/Documents and Settings/.hudson/jobs/<job name>/builds/<buildtime> folder in a file called simply "log".  It is a simple text file.

  14. May 18, 2010

    Rex Morrey says:

    We use Hudson to manage a release schedule of about twice a month.  These r...

    We use Hudson to manage a release schedule of about twice a month.  These releases include code held on branches of various CVS modules, and any module can go at any given release.  A module can have two or more branches under development at any given time.  To manage the build cycle, we create a new Hudson job for each module in a release and include the expected release date of that module in the job name.  By creating a new tab for each release date, we can organize our releases and keep them straight. 

    That said, we want to preserve our build logs for audit purposes even after the build is no longer active.  We zip the job directory after a reasonable period of time, and remove it from the .hudson/jobs directory, so that it does not clutter the Hudson screen, and restart the Hudson service.  If we need to revisit a past module build, we simply unzip the job back into the jobs directory and restart Hudson.

  15. Jun 03, 2010

    anna says:

    hi, when i was building a software,there would be an error message "java.exe ca...

    hi,

    when i was building a software,there would be an error message "java.exe cannot find ordinal number"

    I am very confused with this problem, could anyone else help me and tell me what to do?

    Thanks!!

  16. Jun 09, 2010

    Xav says:

    Hi, Is there a way to use a script to trig the build other than these solutions...

    Hi,

    Is there a way to use a script to trig the build other than these solutions:

    • you can setup a scheduler... But how to stop the build wihtout failling if nothing new to build
    • you can use an extern cron tab to trig the build using URL submission (need external hudson tool & setup)
    • you can add the plugin Dos Trigger, but dos script :'( (Why not a shell script?!?)

    If i'm missing something, thanks to tell me

    Xav

  17. Jun 09, 2010

    Ajay Puthiyedath says:

    Hi, I am trying to build a software project on the CVS,but doesnt seem to be wo...

    Hi,

    I am trying to build a software project on the CVS,but doesnt seem to be working,the same project builds successfully on the local machine but doesnt work on CVS.It gives an error saying "artifacts not found in the specified nexus repo.But when i check the specifies url  in the repo,all the artifacts are present .Checked the pom.xml file too,everything looks perfect and hence works fine fine on the local system.Can anyone help me in this regard.What might be the reasons for this?

  18. Feb 25, 2011

    Jeff Foege says:

    I'm confused as to why Hudson won't do a manual build. I have a svn repo and I h...

    I'm confused as to why Hudson won't do a manual build. I have a svn repo and I have two VisStudio soluntion files to build. When I hit the build button and select debug, Hudson only cleans the workspace and then sync's the code but doesn't do a build because of no changes.What I did was create a local svn repo and another hudson job of an existing project. I wanted to use this second job in Hudson to test with so I don't bother the developers currently working. Then once I have something working I'll move it over to the live job. If I hit the build now button shouldn't Hudson build the code regardless of no changes?

    At the end it only says

    no change for (svn project path) since the previous

    buildFinished: SUCCESS

    Thanks, Jeff

  19. May 10, 2011

    Divyashree K R says:

    Hi, We have the HUDSON configured for the Java build and we also configure HUDS...

    Hi,

    We have the HUDSON configured for the Java build and we also configure HUDSON for running the backup jobs. Currently, we have configured a job with the /cygwin/bin/sshpass.exe using which we are logging to a server and executing a backup script (cmd /c "'D:\Software\ECM\Backup.cmd'"). Even though this command says Build Failed, the HUDSON is showing FINISHED; Success as it is not able to capture the exit code of non-zero value from this Backup.cmd script. Now, how can I capture this exit code and let HUDSON know that build is failed and it should display FINISHED: Failure?

    Any info regarding this would be really helpful.

    Thanks, Divya

  20. Jul 19, 2011

    jackwang0323 says:

    Hi, When i create a new tab-->job, there doesn't generate the according fold...

    Hi,

    When i create a new tab-->job, there doesn't generate the according folder.
    E.g. create new tab(view) "test", create new job "new", there is no the the "test" folder. And the on another slave node, don't have the "jobs" folder. By the way, we use the Hudson version 2.0.1.

    How to deal with this problem? Is there any configuration affecting it?

    Tanks,Jack

  21. Aug 29, 2011

    Shankar Ramasamy says:

    Hi, All the URLs in the environment Variables are Empty in Hudson 2.1.0 %BUILD...

    Hi,

    All the URLs in the environment Variables are Empty in Hudson 2.1.0

    %BUILD_URL%, %JOB_URL% and %HUDSON_URL% variables are empty.

    Please help me with ways of retrieving them.

    Thanks

    Shankar R

    1. Aug 30, 2011

      Winston Prakash says:

      Was it working before? I'll try to reproduce it. You can ask help in the mailing...

      Was it working before? I'll try to reproduce it. You can ask help in the mailing list usersAThudsonDOTjavaDOTnet

  22. Jan 17, 2012

    Pranaya Kumar Kintali says:

    How can I make a build of a specific revision number ? eg., If latest revision ...

    How can I make a build of a specific revision number ?

    eg., If latest revision number is 29999, and if the requirement is 29009 also there is no availability of build in the build history, then How can I make a build of the version 29009 ?

    Can anyone help me out ?