From 9e186eedf1a09ca7ac4fbdea32b00e7e5331f7eb Mon Sep 17 00:00:00 2001 From: James Moger <james.moger@gitblit.com> Date: Sat, 05 Jan 2013 17:52:36 -0500 Subject: [PATCH] Updated documentation --- build.xml | 430 +++++++++++++++++++++++++++++++++++++++++------------ 1 files changed, 330 insertions(+), 100 deletions(-) diff --git a/build.xml b/build.xml index 4d326ea..0088597 100644 --- a/build.xml +++ b/build.xml @@ -14,9 +14,12 @@ <property name="project.build.dir" value="${basedir}/build" /> <property name="project.deploy.dir" value="${basedir}/deploy" /> <property name="project.war.dir" value="${basedir}/war" /> + <property name="project.jar.dir" value="${basedir}/jar" /> <property name="project.site.dir" value="${basedir}/site" /> <property name="project.resources.dir" value="${basedir}/resources" /> <property name="project.express.dir" value="${basedir}/express" /> + <property name="project.maven.repo.url" value="enter here your Maven repo URL" /> + <property name="project.maven.repo.id" value="gitblit.maven.repo" /> <available property="hasBuildProps" file="${basedir}/build.properties"/> <!-- @@ -85,10 +88,14 @@ </loadfile> <property name="distribution.zipfile" value="gitblit-${gb.version}.zip" /> <property name="distribution.warfile" value="gitblit-${gb.version}.war" /> + <property name="distribution.jarfile" value="gitblit-${gb.version}.jar" /> + <property name="distribution.pomfile" value="${basedir}/pom.xml" /> <property name="fedclient.zipfile" value="fedclient-${gb.version}.zip" /> <property name="manager.zipfile" value="manager-${gb.version}.zip" /> + <property name="authority.zipfile" value="authority-${gb.version}.zip" /> <property name="gbapi.zipfile" value="gbapi-${gb.version}.zip" /> <property name="express.zipfile" value="express-${gb.version}.zip" /> + <property name="distribution.pomfileTmplt" value="tmplt.pom.xml" /> </target> @@ -106,6 +113,15 @@ <include name="users.conf" /> </fileset> </copy> + + <!-- copy required distribution files to project folder --> + <mkdir dir="${basedir}/certs" /> + <copy todir="${basedir}/certs" overwrite="false"> + <fileset dir="${basedir}/distrib"> + <include name="authority.conf" /> + <include name="*.tmpl" /> + </fileset> + </copy> <!-- copy gitblit.properties to the WEB-INF folder. this file is only used for parsing setting descriptions. --> @@ -117,12 +133,21 @@ <delete dir="${project.build.dir}" /> <mkdir dir="${project.build.dir}" /> - <javac debug="true" srcdir="${basedir}/src" destdir="${project.build.dir}"> + <javac debug="true" srcdir="${basedir}/src" destdir="${project.build.dir}" includeantruntime="false"> <include name="com/gitblit/build/Build.java" /> <include name="com/gitblit/Constants.java" /> <include name="com/gitblit/utils/StringUtils.java" /> </javac> - <java classpath="${project.build.dir}" classname="com.gitblit.build.Build" /> + + <java classpath="${project.build.dir}" classname="com.gitblit.build.Build" failonerror="true"> + <syspropertyset id="proxy.properties"> + <propertyref prefix="java.net.useSystemProxies"/> + <propertyref prefix="http."/> + <propertyref prefix="https."/> + <propertyref prefix="ftp."/> + <propertyref prefix="socksProxy"/> + </syspropertyset> + </java> <!-- Compile Project --> <path id="master-classpath"> @@ -131,7 +156,7 @@ </fileset> <pathelement path="${project.build.dir}" /> </path> - <javac debug="true" destdir="${project.build.dir}" failonerror="false"> + <javac debug="true" destdir="${project.build.dir}" failonerror="false" includeantruntime="false"> <src path="${basedir}/src" /> <classpath refid="master-classpath" /> </javac> @@ -146,7 +171,7 @@ Build Gitblit GO ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --> - <target name="buildGO" depends="compile" description="Build Gitblit GO distribution"> + <target name="buildGO" depends="compile,buildAuthority" description="Build Gitblit GO distribution"> <echo>Building Gitblit GO ${gb.version}</echo> @@ -160,18 +185,30 @@ <include name="**/*" /> <exclude name="federation.properties" /> <exclude name="openshift.mkd" /> + <exclude name="authority.conf" /> + <exclude name="*.tmpl" /> </fileset> <fileset dir="${basedir}"> <include name="LICENSE" /> <include name="NOTICE" /> + </fileset> + </copy> + <copy tofile="${project.deploy.dir}/authority.jar" file="${basedir}/authority-${gb.version}.jar" /> + + <!-- Certificate templates --> + <mkdir dir="${project.deploy.dir}/certs"/> + <copy todir="${project.deploy.dir}/certs"> + <fileset dir="${basedir}/distrib"> + <include name="*.tmpl" /> + <include name="authority.conf" /> </fileset> </copy> - + <!-- Build jar --> <jar jarfile="${project.deploy.dir}/${project.jar}"> <fileset dir="${project.build.dir}"> <include name="**/*" /> - <exclude name="com/gitblit/client/**" /> + <exclude name="com/gitblit/client/**" /> </fileset> <fileset dir="${project.resources.dir}"> <exclude name="thumbs.db" /> @@ -182,11 +219,13 @@ </jar> <!-- Gitblit library dependencies --> - <mkdir dir="${project.deploy.dir}/lib"/> - <copy todir="${project.deploy.dir}/lib"> + <mkdir dir="${project.deploy.dir}/ext"/> + <copy todir="${project.deploy.dir}/ext"> <fileset dir="${basedir}/ext"> - <exclude name="*-sources.jar" /> - <exclude name="*-javadoc.jar" /> + <exclude name="src/**" /> + <exclude name="junit*.jar" /> + <exclude name="hamcrest*.jar" /> + <exclude name="commons-net*.jar" /> </fileset> </copy> @@ -195,11 +234,15 @@ <param name="docs.output.dir" value="${project.deploy.dir}/docs" /> </antcall> - <!-- Copy the sample Groovy hook scripts --> + <!-- Copy the supported Groovy hook scripts --> <mkdir dir="${project.deploy.dir}/groovy" /> <copy todir="${project.deploy.dir}/groovy"> <fileset dir="${basedir}/groovy"> - <include name="**/*" /> + <include name="sendmail.groovy" /> + <include name="sendmail-html.groovy" /> + <include name="jenkins.groovy" /> + <include name="protect-refs.groovy" /> + <include name="localclone.groovy" /> </fileset> </copy> @@ -224,9 +267,8 @@ <copy todir="${docs.output.dir}"> <!-- Copy selected Gitblit resources --> <fileset dir="${project.resources.dir}"> - <include name="bootstrap.140.css" /> - <include name="bootstrap.gb.css" /> - <include name="markdown.css" /> + <include name="bootstrap/**/*" /> + <include name="gitblit.css" /> <include name="gitblt_25_white.png" /> <include name="gitblt-favicon.png" /> <include name="lock_go_16x16.png" /> @@ -362,11 +404,15 @@ <param name="docs.output.dir" value="${project.war.dir}/WEB-INF/docs" /> </antcall> - <!-- Copy the sample Groovy hook scripts --> + <!-- Copy the supported Groovy hook scripts --> <mkdir dir="${project.war.dir}/WEB-INF/groovy" /> <copy todir="${project.war.dir}/WEB-INF/groovy"> <fileset dir="${basedir}/groovy"> - <include name="**/*" /> + <include name="sendmail.groovy" /> + <include name="sendmail-html.groovy" /> + <include name="jenkins.groovy" /> + <include name="protect-refs.groovy" /> + <include name="localclone.groovy" /> </fileset> </copy> @@ -395,12 +441,13 @@ <mkdir dir="${project.war.dir}/WEB-INF/lib"/> <copy todir="${project.war.dir}/WEB-INF/lib"> <fileset dir="${basedir}/ext"> - <exclude name="*-sources.jar" /> - <exclude name="*-javadoc.jar" /> + <exclude name="src/**" /> <exclude name="jcommander*.jar" /> <exclude name="jetty*.jar" /> <exclude name="junit*.jar" /> + <exclude name="hamcrest*.jar" /> <exclude name="servlet*.jar" /> + <exclude name="javax.servlet*.jar" /> </fileset> </copy> @@ -412,9 +459,10 @@ <exclude name="com/gitblit/tests/" /> <exclude name="com/gitblit/build/**" /> <exclude name="com/gitblit/client/**" /> + <exclude name="com/gitblit/AddIndexedBranch*.class" /> <exclude name="com/gitblit/GitBlitServer*.class" /> <exclude name="com/gitblit/Launcher*.class" /> - <exclude name="com/gitblit/MakeCertificate*.class" /> + <exclude name="com/gitblit/authority/**" /> </fileset> </copy> @@ -423,6 +471,81 @@ </target> + <!-- + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Build Gitblit JAR for usage in other projects plug-ins (i.e. Gerrit) + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + --> + <target name="buildJAR" depends="compile" description="Build Gitblit JAR"> + + <echo>Building Gitblit JAR ${gb.version}</echo> + + <delete dir="${project.jar.dir}" /> + + <!-- Gitblit classes --> + <mkdir dir="${project.jar.dir}"/> + <copy todir="${project.jar.dir}"> + <fileset dir="${project.build.dir}"> + <exclude name="WEB-INF/" /> + <exclude name="com/gitblit/tests/" /> + <exclude name="com/gitblit/build/**" /> + <exclude name="com/gitblit/client/**" /> + <exclude name="com/gitblit/authority/**" /> + <exclude name="com/gitblit/AddIndexedBranch*.class" /> + <exclude name="com/gitblit/GitBlitServer*.class" /> + <exclude name="com/gitblit/Launcher*.class" /> + </fileset> + </copy> + <copy todir="${project.jar.dir}/static"> + <fileset dir="${project.resources.dir}"> + <exclude name="thumbs.db" /> + </fileset> + </copy> + + <!-- Build the JAR file --> + <jar basedir="${project.jar.dir}" destfile="${distribution.jarfile}" compress="true" /> + </target> + + <!-- + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Build pom.xml for GitBlit JAR Maven module + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + --> + <target name="buildMaven" depends="buildJAR" description="Build pom.xml for Gitblit JAR Maven module"> + <copy tofile="${distribution.pomfile}" file="${distribution.pomfileTmplt}"/> + <replace file="${distribution.pomfile}" token="@gb.version@" value="${gb.version}" /> + </target> + + <!-- + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Install Gitblit JAR for usage as Maven module + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + --> + <target name="installMaven" depends="buildMaven" description="Install Gitblit JAR as Maven module"> + <exec executable="mvn"> + <arg value="install:install-file" /> + <arg value="-Dfile=${distribution.jarfile}" /> + <arg value="-DpomFile=${distribution.pomfile}" /> + <arg value="-DcreateChecksum=true" /> + </exec> + </target> + + <!-- + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Upload Gitblit JAR to remote Maven repository + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + --> + <target name="uploadMaven" depends="buildJAR" description="Upload Gitblit JAR to remote Maven repository"> + <exec executable="mvn"> + <arg value="deploy:deploy-file" /> + <arg value="-Dfile=${distribution.jarfile}" /> + <arg value="-DpomFile=${distribution.pomfile}" /> + <arg value="-Durl=${project.maven.repo.url}" /> + <arg value="-DrepositoryId=${project.maven.repo.id}" /> + <arg value="-DcreateChecksum=true" /> + </exec> + </target> + <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Build the stand-alone, command-line Gitblit Federation Client @@ -441,6 +564,7 @@ <exclude name="org.slf4j." /> <exclude name="com.beust." /> <exclude name="com.google." /> + <exclude name="com.unboundid." /> </classfilter> <classpath refid="master-classpath" /> <manifest> @@ -495,6 +619,17 @@ <copy tofile="${deployments.root}/WEB-INF/reference.properties" file="${basedir}/distrib/gitblit.properties"/> + <!-- Copy the supported Groovy hook scripts --> + <mkdir dir="${deployments.root}/WEB-INF/groovy" /> + <copy todir="${deployments.root}/WEB-INF/groovy"> + <fileset dir="${basedir}/groovy"> + <include name="sendmail.groovy" /> + <include name="sendmail-html.groovy" /> + <include name="jenkins.groovy" /> + <include name="protect-refs.groovy" /> + </fileset> + </copy> + <!-- Build the WAR web.xml from the prototype web.xml and gitblit.properties --> <!-- THIS FILE IS NOT OVERRIDDEN ONCE IT IS BUILT!!! --> <java classpath="${project.build.dir}" classname="com.gitblit.build.BuildWebXml"> @@ -521,18 +656,18 @@ <mkdir dir="${deployments.root}/WEB-INF/lib"/> <copy todir="${deployments.root}/WEB-INF/lib"> <fileset dir="${basedir}/ext"> - <exclude name="*-sources.jar" /> - <exclude name="*-javadoc.jar" /> + <exclude name="src/**" /> <exclude name="jcommander*.jar" /> <exclude name="jetty*.jar" /> <exclude name="junit*.jar" /> + <exclude name="hamcrest*.jar" /> <exclude name="servlet*.jar" /> + <exclude name="javax.servlet*.jar" /> </fileset> </copy> <!-- Gitblit classes --> - <mkdir dir="${deployments.root}/WEB-INF/classes"/> - <copy todir="${deployments.root}/WEB-INF/classes"> + <jar destfile="${deployments.root}/WEB-INF/lib/gitblit-${gb.version}.jar"> <fileset dir="${project.build.dir}"> <exclude name="WEB-INF/" /> <exclude name="com/gitblit/tests/" /> @@ -540,9 +675,9 @@ <exclude name="com/gitblit/client/**" /> <exclude name="com/gitblit/GitBlitServer*.class" /> <exclude name="com/gitblit/Launcher*.class" /> - <exclude name="com/gitblit/MakeCertificate*.class" /> + <exclude name="com/gitblit/authority/**" /> </fileset> - </copy> + </jar> <!-- Build Express Zip file --> <zip destfile="${express.zipfile}"> @@ -564,7 +699,9 @@ <resource file="${basedir}/src/com/gitblit/client/splash.png" /> <resource file="${basedir}/resources/gitblt-favicon.png" /> <resource file="${basedir}/resources/gitweb-favicon.png" /> + <resource file="${basedir}/resources/git-orange-16x16.png" /> <resource file="${basedir}/resources/user_16x16.png" /> + <resource file="${basedir}/resources/users_16x16.png" /> <resource file="${basedir}/resources/settings_16x16.png" /> <resource file="${basedir}/resources/lock_go_16x16.png" /> <resource file="${basedir}/resources/lock_pull_16x16.png" /> @@ -579,8 +716,13 @@ <resource file="${basedir}/resources/search-icon.png" /> <resource file="${basedir}/resources/commit_changes_16x16.png" /> <resource file="${basedir}/resources/commit_merge_16x16.png" /> + <resource file="${basedir}/resources/commit_divide_16x16.png" /> <resource file="${basedir}/resources/blank.png" /> <resource file="${basedir}/src/com/gitblit/wicket/GitBlitWebApp.properties" /> + <resource file="${basedir}/src/com/gitblit/wicket/GitBlitWebApp_es.properties" /> + <resource file="${basedir}/src/com/gitblit/wicket/GitBlitWebApp_ja.properties" /> + <resource file="${basedir}/src/com/gitblit/wicket/GitBlitWebApp_ko.properties" /> + <resource file="${basedir}/src/com/gitblit/wicket/GitBlitWebApp_pl.properties" /> <class name="com.gitblit.client.GitblitManagerLauncher" /> <classfilter> @@ -590,6 +732,7 @@ <exclude name="org.slf4j." /> <exclude name="com.beust." /> <exclude name="com.google." /> + <exclude name="com.unboundid." /> </classfilter> <classpath refid="master-classpath" /> <manifest> @@ -610,75 +753,143 @@ </zip> </target> + <!-- - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Build the Gitblit API client library - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - --> - <target name="buildApiLibrary" depends="compile" description="Builds the Gitblit RPC client library"> - <echo>Building Gitblit API Library ${gb.version}</echo> + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Build the stand-alone, Gitblit Authority + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + --> + <target name="buildAuthority" depends="compile" description="Builds the stand-alone Gitblit Authority"> + <echo>Building Gitblit Authority ${gb.version}</echo> + + <genjar jarfile="authority-${gb.version}.jar"> + <resource file="${basedir}/src/com/gitblit/client/splash.png" /> + <resource file="${basedir}/resources/gitblt-favicon.png" /> + <resource file="${basedir}/resources/user_16x16.png" /> + <resource file="${basedir}/resources/users_16x16.png" /> + <resource file="${basedir}/resources/rosette_16x16.png" /> + <resource file="${basedir}/resources/rosette_32x32.png" /> + <resource file="${basedir}/resources/vcard_16x16.png" /> + <resource file="${basedir}/resources/settings_16x16.png" /> + <resource file="${basedir}/resources/settings_32x32.png" /> + <resource file="${basedir}/resources/search-icon.png" /> + <resource file="${basedir}/resources/mail_16x16.png" /> + <resource file="${basedir}/resources/script_16x16.png" /> + <resource file="${basedir}/resources/blank.png" /> + <resource file="${basedir}/resources/bullet_green.png" /> + <resource file="${basedir}/resources/bullet_orange.png" /> + <resource file="${basedir}/resources/bullet_red.png" /> + <resource file="${basedir}/resources/bullet_white.png" /> + <resource file="${basedir}/resources/bullet_delete.png" /> + <resource file="${basedir}/resources/bullet_key.png" /> + <resource file="${basedir}/src/log4j.properties" /> + <resource file="${basedir}/src/com/gitblit/wicket/GitBlitWebApp.properties" /> + <resource file="${basedir}/src/com/gitblit/wicket/GitBlitWebApp_es.properties" /> + <resource file="${basedir}/src/com/gitblit/wicket/GitBlitWebApp_ja.properties" /> + <resource file="${basedir}/src/com/gitblit/wicket/GitBlitWebApp_ko.properties" /> + <resource file="${basedir}/src/com/gitblit/wicket/GitBlitWebApp_pl.properties" /> + + <class name="com.gitblit.authority.GitblitAuthorityLauncher" /> + <classfilter> + <exclude name="org.apache." /> + <exclude name="org.bouncycastle." /> + <exclude name="org.eclipse." /> + <exclude name="org.slf4j." /> + <exclude name="com.beust." /> + <exclude name="com.google." /> + <exclude name="com.unboundid." /> + </classfilter> + <classpath refid="master-classpath" /> + <manifest> + <attribute name="Main-Class" value="com.gitblit.authority.GitblitAuthorityLauncher" /> + <attribute name="SplashScreen-Image" value="splash.png" /> + <attribute name="Specification-Version" value="${gb.version}" /> + <attribute name="Release-Date" value="${gb.versionDate}" /> + </manifest> + </genjar> + + <!-- Build Authority Zip file --> + <zip destfile="${authority.zipfile}"> + <fileset dir="${basedir}"> + <include name="authority-${gb.version}.jar" /> + <include name="LICENSE" /> + <include name="NOTICE" /> + </fileset> + <zipfileset dir="${basedir}/distrib" prefix="certs"> + <include name="authority.conf" /> + <include name="mail.tmpl" /> + <include name="instructions.tmpl" /> + </zipfileset> + </zip> + </target> + + <!-- + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Build the Gitblit API client library + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + --> + <target name="buildApiLibrary" depends="compile" description="Builds the Gitblit RPC client library"> + <echo>Building Gitblit API Library ${gb.version}</echo> + + <!-- Build API Library jar --> + <genjar jarfile="gbapi-${gb.version}.jar"> + <class name="com.gitblit.Keys" /> + <class name="com.gitblit.client.GitblitClient" /> + <classpath refid="master-classpath" /> + <classfilter> + <exclude name="com.google.gson." /> + <exclude name="com.sun.syndication." /> + </classfilter> + <manifest> + <attribute name="Specification-Version" value="${gb.version}" /> + <attribute name="Release-Date" value="${gb.versionDate}" /> + </manifest> + </genjar> - <!-- Build API Library jar --> - <genjar jarfile="gbapi-${gb.version}.jar"> - <class name="com.gitblit.Keys" /> - <class name="com.gitblit.client.GitblitClient" /> - <classpath refid="master-classpath" /> - <classfilter> - <exclude name="com.google.gson." /> - <exclude name="com.sun.syndication." /> - </classfilter> - <manifest> - <attribute name="Specification-Version" value="${gb.version}" /> - <attribute name="Release-Date" value="${gb.versionDate}" /> - </manifest> - </genjar> - - <!-- Build API sources jar --> - <zip destfile="gbapi-${gb.version}-sources.jar"> - <fileset dir="${basedir}/src" defaultexcludes="yes"> - <include name="com/gitblit/Constants.java"/> - <include name="com/gitblit/GitBlitException.java"/> - <include name="com/gitblit/Keys.java"/> - <include name="com/gitblit/client/**/*.java"/> - <include name="com/gitblit/models/**/*.java"/> - <include name="com/gitblit/utils/**/*.java"/> - </fileset> - </zip> - - <!-- Build API JavaDoc jar --> - <javadoc destdir="${basedir}/javadoc"> - <fileset dir="${basedir}/src" defaultexcludes="yes"> - <include name="com/gitblit/Constants.java"/> - <include name="com/gitblit/GitBlitException.java"/> - <include name="com/gitblit/Keys.java"/> - <include name="com/gitblit/client/**/*.java"/> - <include name="com/gitblit/models/**/*.java"/> - <include name="com/gitblit/utils/**/*.java"/> - </fileset> - </javadoc> - <zip destfile="gbapi-${gb.version}-javadoc.jar"> - <fileset dir="${basedir}/javadoc" /> - </zip> - - <!-- Build the API library zip file --> - <zip destfile="${gbapi.zipfile}"> - <fileset dir="${basedir}"> - <include name="gbapi-${gb.version}.jar" /> - <include name="gbapi-${gb.version}-sources.jar" /> - <include name="gbapi-${gb.version}-javadoc.jar" /> - <include name="LICENSE" /> - <include name="NOTICE" /> - </fileset> - <fileset dir="${basedir}/ext"> - <include name="gson*.jar" /> - <exclude name="gson*-sources.jar" /> - <exclude name="gson*-javadoc.jar" /> - <include name="rome*.jar" /> - <exclude name="rome*-sources.jar" /> - <exclude name="rome*-javadoc.jar" /> - </fileset> - </zip> - </target> + <!-- Build API sources jar --> + <zip destfile="gbapi-${gb.version}-sources.jar"> + <fileset dir="${basedir}/src" defaultexcludes="yes"> + <include name="com/gitblit/Constants.java"/> + <include name="com/gitblit/GitBlitException.java"/> + <include name="com/gitblit/Keys.java"/> + <include name="com/gitblit/client/**/*.java"/> + <include name="com/gitblit/models/**/*.java"/> + <include name="com/gitblit/utils/**/*.java"/> + </fileset> + </zip> + + <!-- Build API JavaDoc jar --> + <javadoc destdir="${basedir}/javadoc"> + <fileset dir="${basedir}/src" defaultexcludes="yes"> + <include name="com/gitblit/Constants.java"/> + <include name="com/gitblit/GitBlitException.java"/> + <include name="com/gitblit/Keys.java"/> + <include name="com/gitblit/client/**/*.java"/> + <include name="com/gitblit/models/**/*.java"/> + <include name="com/gitblit/utils/**/*.java"/> + </fileset> + </javadoc> + <zip destfile="gbapi-${gb.version}-javadoc.jar"> + <fileset dir="${basedir}/javadoc" /> + </zip> + + <!-- Build the API library zip file --> + <zip destfile="${gbapi.zipfile}"> + <fileset dir="${basedir}"> + <include name="gbapi-${gb.version}.jar" /> + <include name="gbapi-${gb.version}-sources.jar" /> + <include name="gbapi-${gb.version}-javadoc.jar" /> + <include name="LICENSE" /> + <include name="NOTICE" /> + </fileset> + <fileset dir="${basedir}/ext"> + <exclude name="src/**" /> + <include name="gson*.jar" /> + <include name="rome*.jar" /> + <include name="jdom*.jar" /> + </fileset> + </zip> + </target> <!-- @@ -696,9 +907,8 @@ <copy todir="${project.site.dir}"> <!-- Copy selected Gitblit resources --> <fileset dir="${project.resources.dir}"> - <include name="bootstrap.140.css" /> - <include name="bootstrap.gb.css" /> - <include name="markdown.css" /> + <include name="bootstrap/**/*" /> + <include name="gitblit.css" /> <include name="gitblt_25_white.png" /> <include name="gitblt-favicon.png" /> <include name="lock_go_16x16.png" /> @@ -836,7 +1046,7 @@ Compile from source, publish binaries, and build & deploy site ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --> - <target name="buildAll" depends="buildGO,buildWAR,buildExpress,buildFederationClient,buildManager,buildApiLibrary,buildSite"> + <target name="buildAll" depends="buildAuthority,buildGO,buildWAR,buildExpress,buildFederationClient,buildManager,buildApiLibrary,buildSite"> <!-- Cleanup --> <delete dir="${project.build.dir}" /> <delete dir="${project.war.dir}" /> @@ -844,13 +1054,33 @@ <delete dir="${project.express.dir}" /> </target> + + <!-- + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Update the gh-pages branch with the current site + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + --> + <target name="updateGhPages" depends="buildSite"> + <!-- Build gh-pages branch --> + <java classpath="${project.build.dir}" classname="com.gitblit.build.BuildGhPages"> + <classpath refid="master-classpath" /> + <arg value="--sourceFolder" /> + <arg value="${basedir}/site" /> + + <arg value="--repository" /> + <arg value="${basedir}" /> + + <arg value="--obliterate" /> + </java> + </target> + <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Publish binaries to Google Code ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --> - <target name="publishBinaries" depends="buildGO,buildWAR,buildExpress,buildFederationClient,buildManager" description="Publish the Gitblit binaries to Google Code"> + <target name="publishBinaries" depends="buildGO,buildWAR,buildExpress,buildFederationClient,buildManager,buildApiLibrary" description="Publish the Gitblit binaries to Google Code"> <echo>Uploading Gitblit ${gb.version} binaries</echo> @@ -923,7 +1153,7 @@ You must add ext/commons-net-1.4.0.jar to your ANT classpath. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --> - <target name="publishSite" depends="buildSite" description="Publish the Gitblit site to a webserver (requires ext/commons-net-1.4.0.jar)" > + <target name="publishSite" depends="buildSite,updateGhPages" description="Publish the Gitblit site to a webserver (requires ext/commons-net-1.4.0.jar)" > <echo>Uploading Gitblit ${gb.version} website</echo> @@ -949,4 +1179,4 @@ <delete dir="${project.war.dir}" /> <delete dir="${project.deploy.dir}" /> </target> -</project> +</project> -- Gitblit v1.9.1