Skip to content
Permalink
Browse files
Bring JXPath Maven1 build and site/docs up to date with current pract…
…icea:

- remove dependency on commons-build
- create checksums
- source distro unpacks to different directory
- correct mail archive links (from eyebrowse)
- include NOTICE.txt in jar file
- add "building" page
- add improved "source repository" page
- add improved "issue tracking" page

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/jxpath/trunk@492887 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information
Niall Pemberton committed Jan 5, 2007
1 parent e989284 commit 40ce2876dc6581cde5355c7799072a95c50e46cc
Show file tree
Hide file tree
Showing 10 changed files with 328 additions and 77 deletions.
@@ -15,23 +15,80 @@
limitations under the License.
-->
<project default="java:jar"
xmlns:ant="jelly:ant"
xmlns:j="jelly:core">

<!-- ================================================================== -->
<!-- START : C O M M O N S - B U I L D -->
<!-- Copy into the binary distribution -->
<!-- ================================================================== -->
<!-- Required: Look and Feel for documentation within distributions -->
<!-- ================================================================== -->
<postGoal name="xdoc:copy-resources">
<copy todir="${basedir}/target/docs/style/" failonerror="false">
<fileset dir="${basedir}/../commons-build/xdocs/style">
<include name='**/*'/>
<exclude name='**/CVS/**'/>
</fileset>
<postGoal name="dist:prepare-bin-filesystem">

<copy todir="${maven.dist.bin.assembly.dir}">
<fileset file='${basedir}/NOTICE.txt'/>
<!-- fileset file="${basedir}/RELEASE-NOTES.txt"/ -->
</copy>

</postGoal>

<!-- ================================================================== -->
<!-- END: C O M M O N S - B U I L D -->
<!-- Copy into the source distribution -->
<!-- ================================================================== -->
<postGoal name="dist:prepare-src-filesystem">

<!-- Copy the NOTICE -->
<copy todir="${maven.dist.src.assembly.dir}">
<fileset file='${basedir}/NOTICE.txt'/>
<!-- fileset file="${basedir}/RELEASE-NOTES.txt"/ -->
<fileset file="${basedir}/build.properties.sample"/>
<fileset file="${basedir}/checkstyle.xml"/>
<fileset file="${basedir}/checkstyle.properties"/>
</copy>

<!-- Copy xdoc files -->
<copy todir="${maven.dist.src.assembly.dir}/xdocs">
<fileset dir="./xdocs"/>
</copy>

</postGoal>

<!-- ================================================================== -->
<!-- Create MD5 Check Sums -->
<!-- ================================================================== -->
<postGoal name="dist">

<!-- Create a versioned pom -->
<copy file="${basedir}/project.xml" tofile="${maven.dist.dir}/${maven.final.name}.pom"/>

<!-- create checksum for pom -->
<ant:checksum file="${maven.dist.dir}/${maven.final.name}.pom" property="pom.md5"/>
<ant:echo message="${pom.md5} *${maven.final.name}.pom"
file="${maven.dist.dir}/${maven.final.name}.pom.md5" />

<!-- create checksum for jar -->
<ant:checksum file="${maven.build.dir}/${maven.final.name}.jar" property="jar.md5"/>
<ant:echo message="${jar.md5} *${maven.final.name}.jar"
file="${maven.build.dir}/${maven.final.name}.jar.md5" />

<!-- create checksum for binary zip -->
<ant:checksum file="${maven.dist.dir}/${maven.final.name}.zip" property="zip.md5"/>
<ant:echo message="${zip.md5} *${maven.final.name}.zip"
file="${maven.dist.dir}/${maven.final.name}.zip.md5" />

<!-- create checksum for binary tar.gz -->
<ant:checksum file="${maven.dist.dir}/${maven.final.name}.tar.gz" property="tar.gz.md5"/>
<ant:echo message="${tar.gz.md5} *${maven.final.name}.tar.gz"
file="${maven.dist.dir}/${maven.final.name}.tar.gz.md5" />

<!-- create checksum for source zip -->
<ant:checksum file="${maven.dist.dir}/${maven.final.name}-src.zip" property="src.zip.md5"/>
<ant:echo message="${src.zip.md5} *${maven.final.name}-src.zip"
file="${maven.dist.dir}/${maven.final.name}-src.zip.md5" />

<!-- create checksum for source tar.gz -->
<ant:checksum file="${maven.dist.dir}/${maven.final.name}-src.tar.gz" property="src.tar.gz.md5"/>
<ant:echo message="${src.tar.gz.md5} *${maven.final.name}-src.tar.gz"
file="${maven.dist.dir}/${maven.final.name}-src.tar.gz.md5" />

</postGoal>

</project>
@@ -20,21 +20,32 @@
maven.repo.remote=http://repo1.maven.org/maven

maven.changelog.factory=org.apache.maven.svnlib.SvnChangeLogFactory
maven.changelog.range=120

maven.checkstyle.properties=${basedir}/checkstyle.xml
maven.checkstyle.excludes=**/parser/*
maven.test.failure = false
maven.junit.fork=true
maven.linkcheck.enable=true

maven.compile.source=1.3
maven.compile.target=1.3

# Jar Manifest Additional Attributes
maven.jar.manifest.attributes.list=Implementation-Vendor-Id,X-Compile-Source-JDK,X-Compile-Target-JDK
maven.jar.manifest.attribute.Implementation-Vendor-Id=org.apache
maven.jar.manifest.attribute.X-Compile-Source-JDK=${maven.compile.source}
maven.jar.manifest.attribute.X-Compile-Target-JDK=${maven.compile.target}

# commons site L&F
maven.xdoc.jsl=../commons-build/commons-site.jsl
maven.xdoc.includeProjectDocumentation=no
maven.xdoc.date=left
maven.xdoc.poweredby.image=maven-feather.png
maven.xdoc.version=${pom.currentVersion}
maven.xdoc.developmentProcessUrl=http://jakarta.apache.org/commons/charter.html

# Make the source distro unzip to a different directory
maven.dist.src.assembly.dir=${maven.dist.assembly.dir}/src/${maven.final.name}-src

#maven.proxy.host=
#maven.proxy.port=80
@@ -59,13 +59,13 @@
<name>Commons Dev List</name>
<subscribe>commons-dev-subscribe@jakarta.apache.org</subscribe>
<unsubscribe>commons-dev-unsubscribe@jakarta.apache.org</unsubscribe>
<archive>http://mail-archives.apache.org/eyebrowse/SummarizeList?listName=commons-dev@jakarta.apache.org</archive>
<archive>http://mail-archives.apache.org/mod_mbox/jakarta-commons-dev/</archive>
</mailingList>
<mailingList>
<name>Commons User List</name>
<subscribe>commons-user-subscribe@jakarta.apache.org</subscribe>
<unsubscribe>commons-user-unsubscribe@jakarta.apache.org</unsubscribe>
<archive>http://mail-archives.apache.org/eyebrowse/SummarizeList?listName=commons-user@jakarta.apache.org</archive>
<archive>http://mail-archives.apache.org/mod_mbox/jakarta-commons-user/</archive>
</mailingList>
</mailingLists>

@@ -108,6 +108,7 @@
<artifactId>junit</artifactId>
<!-- type>required</type-->
<version>3.8</version>
<url>http://www.junit.org/</url>
</dependency>
<dependency>
<groupId>ant</groupId>
@@ -118,6 +119,7 @@
<groupId>xml-apis</groupId>
<artifactId>xml-apis</artifactId>
<version>2.0.2</version>
<url>http://xml.apache.org/commons/</url>
</dependency>
<dependency>
<groupId>jdom</groupId>
@@ -129,16 +131,19 @@
<groupId>commons-beanutils</groupId>
<artifactId>commons-beanutils</artifactId>
<version>1.4</version>
<url>http://jakarta.apache.org/commons/beanutils/</url>
</dependency>
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
<version>1.0.4</version>
<url>http://jakarta.apache.org/commons/logging/</url>
</dependency>
<dependency>
<groupId>commons-collections</groupId>
<artifactId>commons-collections</artifactId>
<version>2.0</version>
<url>http://jakarta.apache.org/commons/collections/</url>
</dependency>
<dependency>
<groupId>maven</groupId>
@@ -149,7 +154,7 @@
<properties>
<comment>
&lt;strong&gt;Site Only&lt;/strong&gt; - v1.9.2 (minimum)
required for building the BeanUtils Site documentation.
required for building the Site documentation.
</comment>
</properties>
</dependency>
@@ -173,17 +178,26 @@
</resource>
</resources>
</unitTest>
<resources>
<resource>
<directory>${basedir}</directory>
<targetPath>META-INF</targetPath>
<includes>
<include>NOTICE.txt</include>
</includes>
</resource>
</resources>
</build>

<reports>
<report>maven-junit-report-plugin</report>

<report>maven-jdepend-plugin</report>
<!--report>maven-checkstyle-plugin</report-->
<!--report>maven-changelog-plugin</report-->
<report>maven-changelog-plugin</report>
<!--report>maven-developer-activity-plugin</report-->
<!--report>maven-file-activity-plugin</report-->
<!--report>maven-javadoc-plugin</report-->
<report>maven-javadoc-plugin</report>
<report>maven-jxr-plugin</report>
<report>maven-license-plugin</report>
<!--report>maven-linkcheck-plugin</report-->
@@ -0,0 +1,73 @@
<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<properties>
<title>Building</title>
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
</properties>
<body>
<!-- ================================================== -->
<section name="Overview">
<p>
Commons JXPath uses <a href="http://maven.apache.org">Maven</a> or
<a href="http://ant.apache.org">Ant</a> as a build system.
</p>
</section>
<!-- ================================================== -->
<section name="Maven Goals">
<p>
To build a jar file, change into JXPath's root directory and run
<strong><code>maven jar</code></strong>.
The result will be in the "target" subdirectory.
</p>
<p>
To build the Javadocs, run <strong><code>maven javadoc</code></strong>.
The result will be in "target/docs/apidocs".
</p>
<p>
To build the full website, run <strong><code>maven site</code></strong>.

The result will be in "target/docs".
</p>
<p>
Further details can be found in the
<a href="http://jakarta.apache.org/commons/building.html">commons build instructions</a>.
</p>
</section>
<!-- ================================================== -->
<section name="Ant Goals">
<p>
To build a jar file and the javadocs, change into JXPath's root directory
and run <strong><code>ant dist</code></strong>.
The result will be in the "dist" subdirectory.
</p>
</section>

<!-- ================================================== -->
<section name="Nightly Builds">
<p>
<a href="http://people.apache.org/builds/jakarta-commons/nightly/commons-jxpath/">Nightly Builds</a>
are built once a day from the current SVN HEAD. These are provided purely for test purposes and are <b>NOT
official releases</b> of the Apache Software Foundation - Released versions of Commons JXPath are
available <a href="http://jakarta.apache.org/site/downloads/downloads_commons-jxpath.cgi">here</a>.
</p>
</section>

<!-- ================================================== -->
</body>
</document>
@@ -0,0 +1,52 @@
<?xml version="1.0" encoding="ISO-8859-1" ?>
<!--
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->

<document>
<properties>
<title>Source repository</title>
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
</properties>
<body>
<!-- ================================================== -->
<section name="Source repository">
<p>
Jakarta Commons JXPath is hosted on the Apache
<a href="http://subversion.tigris.org/">subversion</a> repository.
</p>
<p>
The project URL is:<br />
<code>http://svn.apache.org/repos/asf/jakarta/commons/proper/jxpath/trunk</code>
</p>
<p>
The best way to view the repository is via the
<a href="http://svn.apache.org/viewvc/jakarta/commons/proper/jxpath/trunk/">subversion viewer</a>.
</p>
<p>
The alternative is to use the
<a href="http://svn.apache.org/repos/asf/jakarta/commons/proper/jxpath/trunk/">native subversion</a> display.
</p>
<p>
For more information on subversion and creating patches see the
<a href="http://www.apache.org/dev/contributors.html">Apache Contributors Guide</a>.
</p>
</section>
<!-- ================================================== -->
</body>
</document>
@@ -103,11 +103,5 @@ while (it.hasNext()){
</ul>
</section>

<section name="Nightly Build">
<p>
Nightly build can be found <a href="http://svn.apache.org/builds/jakarta-commons/nightly/commons-jxpath/">here</a>.
</p>
</section>

</body>
</document>

0 comments on commit 40ce287

Please sign in to comment.