Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
61 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,72 +1,102 @@ | ||
| How to build | ||
| ============ | ||
| <img src="http://static.jboss.org/hibernate/images/hibernate_logo_whitebkg_200px.png" /> | ||
|
|
||
| *Starting with development of version 4.0, Hibernate uses [Gradle](http://gradle.org) as its build tool.* | ||
|
|
||
| This README describes some of the basics developers and contributors new to Gradle need to know to get productive quickly. | ||
| Hibernate ORM is a component/library providing Object/Relational Mapping (ORM) support | ||
| to applications and other components/libraries. It is also provides an implementation of the | ||
| JPA specification, which is the standardized Java specification for ORM. See | ||
| [Hibernate.org](http://hibernate.org/orm/) for additional information. | ||
|
|
||
| ### protected | ||
| [](http://ci.hibernate.org/job/hibernate-orm-master-h2/) | ||
| ### unprotected | ||
| [](http://ci.hibernate.org/job/hibernate-orm-master-h2/) | ||
|
|
||
|
|
||
| Quickstart | ||
| ---------- | ||
| ========== | ||
|
|
||
| git clone git://github.com/hibernate/hibernate-orm.git | ||
| cd hibernate-orm | ||
| ./gradlew clean build | ||
| If you are having problems with unresolved dependencies you need to configure access to the JBoss Nexus repository | ||
| (see below). | ||
|
|
||
| The build requires a Java 8 JDK as JAVA_HOME, but will ensure Java 6 compatibility. | ||
|
|
||
|
|
||
| Resources | ||
| --------- | ||
| ========= | ||
| Hibernate uses [Gradle](http://gradle.org) as its build tool. See the _Gradle Primer_ section below if you are new to | ||
| Gradle. | ||
|
|
||
| ### General | ||
| Contributors should read the [Contributing Guide](CONTRIBUTING.md) | ||
|
|
||
| * [Building Hibernate ORM](https://community.jboss.org/wiki/BuildingHibernateORM4x) | ||
| See the guides for setting up [IntelliJ](https://developer.jboss.org/wiki/ContributingToHibernateUsingIntelliJ) or | ||
| [Eclipse]() as your development environment. [Building Hibernate ORM](https://community.jboss.org/wiki/BuildingHibernateORM4x) | ||
| is somewhat outdated, but still has | ||
|
|
||
| ### JBoss Nexus | ||
|
|
||
| * [JBoss Nexus User Guide](http://community.jboss.org/wiki/MavenGettingStarted-Users) - explains how to set up _~/.m2/settings.xml_ to use JBoss Nexus repo. | ||
| CI Builds | ||
| ========= | ||
|
|
||
| ### Gradle | ||
| Hibernate makes use of [Jenkins](http://jenkins.org) for its CI needs. The project is built continuous on each | ||
| push to the upstream repository. Overall there are a few different jobs, all of which can be seen at | ||
| [http://ci.hibernate.org/view/ORM/](http://ci.hibernate.org/view/ORM/) | ||
|
|
||
| * [Gradle User Guide](http://gradle.org/docs/current/userguide/userguide_single.html) | ||
| * [Gradle DSL Guide](http://gradle.org/docs/current/dsl/index.html) | ||
|
|
||
| Executing Tasks | ||
| --------------- | ||
|
|
||
| Gradle uses the concept of build tasks (equivalent to Ant targets). You can get a list of available tasks | ||
| via | ||
| Gradle primer | ||
| ============= | ||
|
|
||
| gradle tasks | ||
| This section describes some of the basics developers and contributors new to Gradle might | ||
| need to know to get productive quickly. The Gradle documentation is very well done; 2 in | ||
| particular that are indispensable: | ||
|
|
||
| or if using gradle wrapper | ||
| * [Gradle User Guide](http://gradle.org/docs/current/userguide/userguide_single.html) is a typical user guide in that | ||
| it follows a topical approach to describing all of the capabilities of Gradle. | ||
| * [Gradle DSL Guide](http://gradle.org/docs/current/dsl/index.html) is quite unique and excellent in quickyl | ||
| getting up to speed on certain aspects of Gradle. | ||
|
|
||
| ./gradlew tasks | ||
|
|
||
| ### Executing Tasks Across All Modules | ||
| Using the Gradle Wrapper | ||
| ------------------------ | ||
|
|
||
| To execute a task across all modules, simply perform that task from the root directory. Gradle will visit each | ||
| subproject and execute that task if the subproject defines it. | ||
| For contributors who do not otherwise use Gradle and do not want to install it, Gradle offers a very cool | ||
| features called the wrapper. It lets you run Gradle builds without a previously installed Gradle distro in | ||
| a zero-conf manner. Hibernate configures the Gradle wrapper for you. If you would rather use the wrapper and | ||
| not install Gradle (or to make sure you use the version of Gradle intended for older builds) you would just use | ||
| the command `gradlew` (or `gradlew.bat`) rather than `gradle` (or `gradle.bat`) in the following discussions. | ||
| Note that `gradlew` is only available in the project's root dir, so depending on your `pwd` you may need to adjust | ||
| the path to `gradlew` as well. | ||
|
|
||
| Executing Tasks | ||
| --------------- | ||
|
|
||
| ### Executing Tasks In Specific Module | ||
| Gradle uses the concept of build tasks (equivalent to Ant targets or Maven phases/goals). You can get a list of | ||
| available tasks via | ||
|
|
||
| To execute a task in a specific module you can either: | ||
| gradle tasks | ||
|
|
||
| To execute a task across all modules, simply perform that task from the root directory. Gradle will visit each | ||
| sub-project and execute that task if the sub-project defines it. To execute a task in a specific module you can | ||
| either: | ||
|
|
||
| 1. `cd` into that module directory and execute the task | ||
| 2. name the "task path". For example, in order to run the tests for the _hibernate-core_ module from the root directory you could say `gradle hibernate-core:test` | ||
|
|
||
| ### Common Java related tasks | ||
| Common Java related tasks | ||
| ------------------------- | ||
|
|
||
| * _build_ - Assembles (jars) and tests this project | ||
| * _buildDependents_ - Assembles and tests this project and all projects that depend on it. So think of running this in hibernate-entitymanager, Gradle would assemble and test hibernate-entitymanager as well as hibernate-envers (because envers depends on entitymanager) | ||
| * _classes_ - Compiles the main classes | ||
| * _testClasses_ - Compiles the test classes | ||
| * _compile_ (Hibernate addition) - Performs all compilation tasks including staging resources from both main and test | ||
| * _jar_ - Generates a jar archive with all the compiled classes | ||
| * _test_ - Runs the tests | ||
| * _publish_ - Think Maven deploy | ||
| * _publishToMavenLocal_ - Installs the project jar to your local maven cache (aka ~/.m2/repository) | ||
| * _publishToMavenLocal_ - Installs the project jar to your local maven cache (aka ~/.m2/repository). Note that Gradle | ||
| never uses this, but it can be useful for testing your build with other local Maven-based builds. | ||
| * _eclipse_ - Generates an Eclipse project | ||
| * _idea_ - Generates an IntelliJ/IDEA project. | ||
| * _idea_ - Generates an IntelliJ/IDEA project (although the preferred approach is to use IntelliJ's Gradle import). | ||
| * _clean_ - Cleans the build directory | ||
|
|