Skip to content

Commit

Permalink
INT-2388 Update Gradle build
Browse files Browse the repository at this point in the history
This is a significant update to the build system, including the changes
listed below. README.md has been updated with instructions on the most
important day-to-day commands.

 - Eliminate buildSrc submodule

   In favor of using the new bundlor and docbook-reference plugins. The
   net effect is a large reduction in number of lines of build code.
   Common docbook resources, stylesheets, etc are stored directly in the
   docbook plugin.

   This means that --recursive is no longer required when cloning and
   there will never be a need to use `git submodule` commands. README
   files have been updated to reflect.

   Use of the new bundlor plugin also means the removal of template.mf
   files from the source tree in favor of an inline approach. See
   build.gradle for details. Bundlor 'import templates' are built up
   programmatically and kept physically close to gradle dependency
   declarations, leading to more convenience when changing these values
   and hopefully fewer errors / version inconsistencies over time.

   Certain tests depended on the presence of template.mf files, all of
   which have recently been removed from the source tree in favor of the
   new bundlor plugin which allows for inlining bundlor configuration
   within the Gradle build script. These tests now create temp files
   using the java.io.File API instead.

 - Upgrade to Gradle 1.0-milestone-6

   The m6 release is significantly faster when resolving dependencies
   and has a number of valuable new features over the earlier m3
   version. Review the release notes for Gradle 1.0-milestone-6 online
   for full details.

 - Switch to repo.springsource.org repository

   Previously the project build declared as many repositories as
   necessary to resolve all project dependencies.

   Now depending on a single 'virtual repository' defined within the
   SpringSource Artifactory instance at http://repo.springsource.org.
   Currently, the virtual repository in use is 'libs-milestone', which
   allows for the resolution of all "milestone-or-better" versions of
   all S2 and third-party dependencies.

   Should snapshot dependencies become required, this value may be
   changed from 'libs-milestone' to 'libs-snapshot'. To build only
   against GA releases, change the value to 'libs-release'.

 - New build plan(s)

   Spring Integration build plans have been updated to use the
   Artifactory Bamboo plugin and publish to repo.springsource.org.
   Build plans have names like 2.1.x to reflect the version under
   development, not necessarily the name of the branch, as this may
   change over time and across major releases.

 - Improve release process

   As mentioned above, Spring Integration will now use the Artifactory
   Bamboo plugin to publish releases and also use Artifactory's support
   for pushing builds directly into Maven Central via oss.sonatype.org.

   Generate poms that contain all necessary fields for onboarding at
   Maven central (scm, developers, organization, licenses, etc).

   Generate -source and -javadoc poms to comply with Maven Central
   onboarding rules (and for general good practice anyway).

   Generation of PGP signatures, sha1 and md5 checksums are all handled
   automatically by Artifactory. These are also requirements for
   automated entry into Maven Central.

 - Remove source-level pom generation

   Automatic generation of Maven poms suitable for use in building
   Spring Integration is no longer supported. Generation and
   publication of poms for the purpose of dependency management remains
   supported.

   Sonar support has to date depended on these poms, but will be
   switched over to use the Gradle Sonar plugin shortly.

 - Eliminate docs subproject

   Move docs/src to the root of the project and eliminate docs as a
   formal subproject. This simplifies the build in a number of ways,
   including removing the need for distinguishing between 'subprojects'
   and 'javaprojects' as well as allowing users to build both 'api' and
   'reference' docs without qualifying with a ':docs' prefix.

   Also rename the src/info directory to src/dist to better reflect that
   these files are packaged with the distribution. For example, the
   readme.txt there is really the distribution readme, distinct from the
   README.md at the root of the project which is for building from source,
   etc.
  • Loading branch information
cbeams authored and markfisher committed Jan 5, 2012
1 parent ae0ecff commit f30da93
Show file tree
Hide file tree
Showing 225 changed files with 808 additions and 7,507 deletions.
3 changes: 0 additions & 3 deletions .gitmodules

This file was deleted.

Binary file added .wrapper/gradle-wrapper.jar
Binary file not shown.
6 changes: 6 additions & 0 deletions .wrapper/gradle-wrapper.properties
@@ -0,0 +1,6 @@
#Wed Dec 21 17:31:27 CET 2011
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=http\://repo.gradle.org/gradle/distributions/gradle-1.0-milestone-6-bin.zip
35 changes: 20 additions & 15 deletions README.md
Expand Up @@ -5,17 +5,29 @@ Spring Integration

To check out the project and build from source, do the following:

git clone --recursive git://github.com/SpringSource/spring-integration.git
git clone git://github.com/SpringSource/spring-integration.git
cd spring-integration
./gradlew build

> Note: the **<code>--recursive</code>** switch above is important, as spring-integration uses
> *git submodules*, which must themselves be cloned and initialized. If **<code>--recursive</code>**
> is omitted, the checkout becomes a multi-step process.
If you encounter out of memory errors during the build, increase available heap and permgen for Gradle:

If you encounter heap space errors during the build, increase the heap size for Gradle:
GRADLE_OPTS='-XX:MaxPermSize=1024m -Xmx1024m'

GRADLE_OPTS="-Xmx1024m"
To build and install jars into your local Maven cache:

./gradlew install

To build api Javadoc (results will be in `build/api`):

./gradlew api

To build reference documentation (results will be in `build/reference`):

./gradlew reference

To build complete distribution including `-dist`, `-docs`, and `-schema` zip files (results will be in `build/distributions`)

./gradlew dist

# Using Eclipse

Expand All @@ -36,14 +48,6 @@ To generate IDEA metadata (.iml and .ipr files), do the following:

./gradlew idea

# Generating JavaDoc

To build the JavaDoc, do the following from within the root directory:

./gradlew :docs:api

The result will be available in **'docs/build/api'**.

# OSGI Notes

1. Dependency on Third Party Bundles
Expand All @@ -69,4 +73,5 @@ The result will be available in **'docs/build/api'**.

# Resources

For more information, please visit the Spring Integration website at: [http://www.springsource.org/spring-integration](http://www.springsource.org/spring-integration)
For more information, please visit the Spring Integration website at:
[http://www.springsource.org/spring-integration](http://www.springsource.org/spring-integration)

0 comments on commit f30da93

Please sign in to comment.