Automated Builds

From Eclipsepedia

Revision as of 14:55, 25 April 2011 by Tcarroll.azigo.com (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Higgins logo 76Wx100H.jpg

Contents

Higgins Auto-build project

The build scripts located in the org.eclipse.higgins.auto project (project.psf projectWithDeps.psf) perform automated builds of Higgins Components on the Eclipse build server (build.eclipse.org).

To add a new component to the list of the those being built automatically every night do the following:

  1. Create build.xml and dependencies.xml files in the root folder of each new project using Higgins2Ant plugin. The same steps should be repeated for all the projects depended on the new project that you are adding to autobuild.
  2. Add description of the new component to projects.xml file in the org.eclipse.higgins.auto.resources project.
  3. Add the SVN repository location of the new component to the resourceLocation.xml file in the org.eclipse.higgins.auto.resources project. The same step should be repeated for all the projects dependent on the new component that you are adding. The file resourceLocation.xml should also contain the lib id and url of all 3rd party libs that the new component and it's sub-components depend on.

See Higgins downloads

See Starting a Higgins Build

See Higgins Committers and Contributors#Processes

See How To Test Autobuild On Local Machine

See How Autobuild Gets Dependencies

General Server Information

Nightly builds of Higgins Components are performed on Eclipse build server.

Connection Type  :ssh:
Host build.eclipse.org
Build Path /shared/technology/higgins


General SVN Information

Connection Type Committers https:// or svn+ssh://
Anonymous access http://
Host dev.eclipse.org
Repository Path /svnroot/technology/org.eclipse.higgins


Location of the build scripts

Project Module Location Eclipse PSF ViewSVN
Automated Build Scripts /trunk/builds/org.eclipse.higgins.auto project.psf viewsvn
projectWithDeps.psf

higgins2ant plugin

The build files and dependencies.xml files for build projects can be generated by using the Higgins2Ant plugin.

Location of the configuration xml files

Project Module Location Eclipse PSF ViewSVN
Automated Build Configuration trunk/builds/org.eclipse.higgins.auto.resources project.psf viewsvn
projectWithDeps.psf

dependencies.xml

dependencies.xml provides the build process with information on required projects and/or libraries.

Build scripts use dependencies.xml file with the structure below as generated by Eclipse IDE.

<?xml version="1.0" encoding="UTF-8"?>
<dependencies id="org.eclipse.higgins.icard.provider.cardspace.common">
	<!-- list of projects that are required -->
    <higginsProjects>
        <project id="org.eclipse.higgins.registry"/>
        <project id="org.eclipse.higgins.icard"/>
    </higginsProjects>
	<!-- libs that should be downloaded to the project. can be multiple for different locations -->
    <remoteLibs location="lib">
        <library id="commons-logging-1.1.jar"/>
        <library id="serializer.jar"/>
        <library id="xalan.jar"/>
        <library id="xercesImpl.jar"/>
        <library id="xmlsec-1.4.0.jar"/>
    </remoteLibs>
</dependencies>

Description of a component in the project.xml file

Description of a component points to which targets to run from the component’s build file and a location where build results will be placed for downloads. Also this file contains mail lists for notification capability on success & fail.

Below is an example of currently used description of a component .

<?xml version="1.0" encoding="UTF-8"?>
<buildProject>
	<!-- path from webHome to plase build -->
	<pathFromWebHome>hbx</pathFromWebHome>
	<!-- path from webHome to place updates (optional) update don't happen if not exists-->
	<updatePath>hbx/update</updatePath>
	<!-- prevent source zip (optional) ignored if contains false -->
	<noSource></noSource>
	<!-- prevent publish, don't creates index.html (optional) ignored if contains false -->
	<noPublish />
	<!-- comma-separated list of recipients. Sends to notify of success component build. (optional) -->
	<successMailList>pkimlach@aquasoft.dp.ua,vkokhan@aquasoft.dp.ua</successMailList>
	<!-- comma-separated list of recipients. Sends to notify of component build target fail. (optional) -->
	<failMailList>pkimlach@aquasoft.dp.ua</failMailList>
	<!-- targets to run --> 
	<targetToRun>xpi</targetToRun>
	<targetToRun>jar</targetToRun>
</buildProject>

“global repository” of required resources

The file resourceLocation.xml contains information about where to get the component. The structure of this file is very simple and is shown below:

<?xml version="1.0" encoding="UTF-8"?>
<resources>
	<repositories>
                <!-- project identifier-->
		<project id="org.eclipse.higgins.hbx">
	                <!-- SVN revision (any svn supported format) -->
        		<version>HEAD</version>
		        <!-- repository identification string -->
		        <repositoryLocation>
	        		http://dev.eclipse.org/svnroot/technology/org.eclipse.higgins
          		</repositoryLocation>
        		<!-- password -->
	        	<password></password>
          		<!-- path from SVN root to the project location -->
          	     	<path>trunk/builds/org.eclipse.higgins.auto</path>
		</project>
	</repositories>
	<!-- libs that can necessary to build component -->
	<remoteLibs>
		<!-- lib identifier -->	
		<lib id="commons-logging-1.1.jar">
			<!-- URL where library is available -->
			<url>
				http://apache.net.ua/commons/logging/binaries/commons-logging-1.1.zip
			</url>
		<!-- these parameters are used to generate project's dependency page.-->
			<libraryHomePage name="Home Page Name">
				<url>http://libraryHomePage.url</url>
			</libraryHomePage>
			<comment>comment</comment>
			<version>version</version>
			<license name="Library license name">
				<url>http://license.url</url>
			</license>
			<eclipseApproved>[yes|no|some text]</eclipseApproved>
		</lib>
		<!-- lib can be available as single *.jar file or stored in archive package (*.zip, *.tgz, *.gz, *.bz) and will be find automatically -->	
		<lib id="arq.jar">
			<url>
				http://shangrila.parityinc.net:8888/projects_deps/arq.jar
			</url>
		</lib>
	</remoteLibs>
</resources>

Add new component to auto projects.xml only in the presence of information about component and dependencies repositories and location of all required libs (for dependencies as well).

Helper targets

Helper target calls after execution of target from projects build.xml file to ${finishDir}. Helper target can contain some transformation (for example: zip task). In current version of auto builder implemented helper targets for {plugin, jar, javadoc, xpi} targets. To add the possibility of a new target execution you need to add a new target with the name «on_<newTargetToRunName>» which will move results of newTargetToRunName execution to ${finishDir}with ziping or some other transformation (if necessary).

See Also

  • The "Downloads" column of each Component's table (see Components) has a link to a page containing the automated build output