From d65f712ea3d8941f4b9145c0630c30c20af80d13 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Fri, 11 Nov 2011 17:22:21 -0500
Subject: [PATCH] Documentation. Add javadoc and source jars to the gbapi download.
---
build.xml | 171 +++++++++++++++++++++++++++++++++++++++++++++++----------
1 files changed, 141 insertions(+), 30 deletions(-)
diff --git a/build.xml b/build.xml
index 97df46c..8ba2b5a 100644
--- a/build.xml
+++ b/build.xml
@@ -85,7 +85,8 @@
<property name="distribution.zipfile" value="gitblit-${gb.version}.zip" />
<property name="distribution.warfile" value="gitblit-${gb.version}.war" />
<property name="fedclient.zipfile" value="fedclient-${gb.version}.zip" />
- <property name="rpcclient.zipfile" value="rpcclient-${gb.version}.zip" />
+ <property name="manager.zipfile" value="manager-${gb.version}.zip" />
+ <property name="gbapi.zipfile" value="gbapi-${gb.version}.zip" />
</target>
@@ -103,6 +104,11 @@
<include name="users.properties" />
</fileset>
</copy>
+
+ <!-- copy gitblit.properties to the WEB-INF folder.
+ this file is only used for parsing setting descriptions. -->
+ <copy tofile="${basedir}/src/WEB-INF/reference.properties" overwrite="true"
+ file="${basedir}/distrib/gitblit.properties" />
<!-- Compile the build tool and execute it.
This downloads missing compile-time dependencies from Maven. -->
@@ -162,6 +168,7 @@
<jar jarfile="${project.deploy.dir}/${project.jar}">
<fileset dir="${project.build.dir}">
<include name="**/*" />
+ <exclude name="com/gitblit/client/**" />
</fileset>
<fileset dir="${project.resources.dir}">
<exclude name="thumbs.db" />
@@ -252,7 +259,7 @@
<arg value="index=overview" />
<arg value="--alias" />
- <arg value="properties=gitblit.properties" />
+ <arg value="properties=settings" />
<arg value="--substitute" />
<arg value="%VERSION%=${gb.version}" />
@@ -267,7 +274,10 @@
<arg value="%FEDCLIENT%=${fedclient.zipfile}" />
<arg value="--substitute" />
- <arg value="%RPCCLIENT%=${rpcclient.zipfile}" />
+ <arg value="%MANAGER%=${manager.zipfile}" />
+
+ <arg value="--substitute" />
+ <arg value="%API%=${gbapi.zipfile}" />
<arg value="--substitute" />
<arg value="%BUILDDATE%=${gb.versionDate}" />
@@ -319,6 +329,10 @@
</fileset>
</copy>
+ <!-- Copy gitblit.properties as reference.properties -->
+ <copy tofile="${project.war.dir}/WEB-INF/reference.properties"
+ file="${basedir}/distrib/gitblit.properties"/>
+
<!-- Build the docs for the WAR build -->
<antcall target="buildDocs" inheritall="true" inheritrefs="true">
<param name="docs.output.dir" value="${project.war.dir}/WEB-INF/docs" />
@@ -365,9 +379,10 @@
<exclude name="WEB-INF/web.xml" />
<exclude name="com/gitblit/tests/" />
<exclude name="com/gitblit/build/**" />
+ <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/MakeCertificate*.class" />
</fileset>
</copy>
@@ -398,7 +413,7 @@
<classpath refid="master-classpath" />
<manifest>
<attribute name="Main-Class" value="com.gitblit.FederationClientLauncher" />
- <attribute name="Specification-Version" value="${gb.version}" />
+ <attribute name="Specification-Version" value="${gb.version}" />
<attribute name="Release-Date" value="${gb.versionDate}" />
</manifest>
</genjar>
@@ -406,10 +421,12 @@
<!-- Build the federation client zip file -->
<zip destfile="${fedclient.zipfile}">
<fileset dir="${basedir}">
- <include name="fedclient.jar" />
+ <include name="fedclient.jar" />
+ <include name="LICENSE" />
+ <include name="NOTICE" />
</fileset>
<fileset dir="${basedir}/distrib">
- <include name="federation.properties" />
+ <include name="federation.properties" />
</fileset>
</zip>
</target>
@@ -417,15 +434,18 @@
<!--
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Build the stand-alone, Gitblit RPC Client
+ Build the stand-alone, Gitblit Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-->
- <target name="buildRpcClient" depends="compile" description="Builds the stand-alone Gitblit RPC client">
- <echo>Building Gitblit RPC Client ${gb.version}</echo>
+ <target name="buildManager" depends="compile" description="Builds the stand-alone Gitblit Manager">
+ <echo>Building Gitblit Manager ${gb.version}</echo>
- <genjar jarfile="rpcclient.jar">
+ <genjar jarfile="maanager-${gb.version}.jar">
<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/user_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" />
<resource file="${basedir}/resources/shield_16x16.png" />
@@ -433,10 +453,16 @@
<resource file="${basedir}/resources/cold_16x16.png" />
<resource file="${basedir}/resources/book_16x16.png" />
<resource file="${basedir}/resources/bug_16x16.png" />
+ <resource file="${basedir}/resources/health_16x16.png" />
+ <resource file="${basedir}/resources/feed_16x16.png" />
+ <resource file="${basedir}/resources/bullet_feed.png" />
+ <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/blank.png" />
<resource file="${basedir}/src/com/gitblit/wicket/GitBlitWebApp.properties" />
- <class name="com.gitblit.client.GitblitClientLauncher" />
+ <class name="com.gitblit.client.GitblitManagerLauncher" />
<classfilter>
<exclude name="org.apache." />
<exclude name="org.bouncycastle." />
@@ -447,20 +473,92 @@
</classfilter>
<classpath refid="master-classpath" />
<manifest>
- <attribute name="Main-Class" value="com.gitblit.client.GitblitClientLauncher" />
+ <attribute name="Main-Class" value="com.gitblit.client.GitblitManagerLauncher" />
<attribute name="SplashScreen-Image" value="splash.png" />
- <attribute name="Specification-Version" value="${gb.version}" />
+ <attribute name="Specification-Version" value="${gb.version}" />
<attribute name="Release-Date" value="${gb.versionDate}" />
</manifest>
</genjar>
- <!-- Build the rpc client zip file -->
- <zip destfile="${rpcclient.zipfile}">
+ <!-- Build Manager Zip file -->
+ <zip destfile="${manager.zipfile}">
<fileset dir="${basedir}">
- <include name="rpcclient.jar" />
- </fileset>
+ <include name="manager-${gb.version}.jar" />
+ <include name="LICENSE" />
+ <include name="NOTICE" />
+ </fileset>
</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 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>
<!--
@@ -564,7 +662,7 @@
<arg value="index=overview" />
<arg value="--alias" />
- <arg value="properties=gitblit.properties" />
+ <arg value="properties=settings" />
<arg value="--substitute" />
<arg value="%VERSION%=${gb.version}" />
@@ -579,7 +677,10 @@
<arg value="%FEDCLIENT%=${fedclient.zipfile}" />
<arg value="--substitute" />
- <arg value="%RPCCLIENT%=${rpcclient.zipfile}" />
+ <arg value="%MANAGER%=${manager.zipfile}" />
+
+ <arg value="--substitute" />
+ <arg value="%API%=${gbapi.zipfile}" />
<arg value="--substitute" />
<arg value="%BUILDDATE%=${gb.versionDate}" />
@@ -611,7 +712,7 @@
Compile from source, publish binaries, and build & deploy site
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-->
- <target name="buildAll" depends="buildGO,buildWAR,buildFederationClient,buildRpcClient,buildSite">
+ <target name="buildAll" depends="buildGO,buildWAR,buildFederationClient,buildManager,buildApiLibrary,buildSite">
<!-- Cleanup -->
<delete dir="${project.build.dir}" />
<delete dir="${project.war.dir}" />
@@ -624,11 +725,11 @@
Publish binaries to Google Code
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-->
- <target name="publishBinaries" depends="buildGO,buildWAR,buildFederationClient,buildRpcClient" description="Publish the Gitblit binaries to Google Code">
+ <target name="publishBinaries" depends="buildGO,buildWAR,buildFederationClient,buildManager" description="Publish the Gitblit binaries to Google Code">
<echo>Uploading Gitblit ${gb.version} binaries</echo>
- <!-- Upload ZIP file -->
+ <!-- Upload Gitblit GO ZIP file -->
<gcupload
username="${googlecode.user}"
password="${googlecode.password}"
@@ -638,7 +739,7 @@
summary="Gitblit GO v${gb.version} (standalone, integrated Gitblit server)"
labels="Featured, Type-Package, OpSys-All" />
- <!-- Upload WAR file -->
+ <!-- Upload Gitblit WAR file -->
<gcupload
username="${googlecode.user}"
password="${googlecode.password}"
@@ -648,7 +749,7 @@
summary="Gitblit WAR v${gb.version} (standard WAR webapp for servlet containers)"
labels="Featured, Type-Package, OpSys-All" />
- <!-- Upload FedClient -->
+ <!-- Upload Gitblit FedClient -->
<gcupload
username="${googlecode.user}"
password="${googlecode.password}"
@@ -658,14 +759,24 @@
summary="Gitblit Federation Client v${gb.version} (command-line tool to clone data from federated Gitblit instances)"
labels="Featured, Type-Package, OpSys-All" />
- <!-- Upload RpcClient -->
+ <!-- Upload Gitblit Manager -->
<gcupload
username="${googlecode.user}"
password="${googlecode.password}"
projectname="gitblit"
- filename="${rpcclient.zipfile}"
- targetfilename="rpcclient-${gb.version}.zip"
- summary="Gitblit RPC Client v${gb.version} (Swing tool to clone repositories and remotely administer a Gitblit server)"
+ filename="${manager.zipfile}"
+ targetfilename="manager-${gb.version}.zip"
+ summary="Gitblit Manager v${gb.version} (Swing tool to remotely administer a Gitblit server)"
+ labels="Featured, Type-Package, OpSys-All" />
+
+ <!-- Upload Gitblit API Library -->
+ <gcupload
+ username="${googlecode.user}"
+ password="${googlecode.password}"
+ projectname="gitblit"
+ filename="${gbapi.zipfile}"
+ targetfilename="gbapi-${gb.version}.zip"
+ summary="Gitblit API Library v${gb.version} (JSON RPC library to integrate with your software)"
labels="Featured, Type-Package, OpSys-All" />
</target>
@@ -696,7 +807,7 @@
Compile from source, publish binaries, and build & deploy site
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-->
- <target name="publishAll" depends="publishBinaries,publishSite">
+ <target name="publishAll" depends="publishBinaries,publishSite">
<!-- Cleanup -->
<delete dir="${project.build.dir}" />
<delete dir="${project.war.dir}" />
--
Gitblit v1.9.1