15c2d16866
* GH-3438: Add Build from Source into CONTRIBUTING Fixes https://github.com/spring-projects/spring-integration/issues/3438 It is not clear at the moment what Java version and what build system is used in the project from the `CONTRIBUTING.adoc` * Add `Build from Source` section into the `CONTRIBUTING.adoc` * Point to the `CONTRIBUTING.adoc` from the top level `README.md` * Fix the current Java version in the `README.md` * Mention that `Squash commits` must be avoided for subsequent commits into the PR * * Apply suggest change for docs result * Change Travis config to use `oraclejdk11` which is minimal already for for the project
64 lines
2.2 KiB
Markdown
64 lines
2.2 KiB
Markdown
Spring Integration [<img src="https://build.spring.io/plugins/servlet/wittified/build-status/INT-MASTER">](https://build.spring.io/browse/INT-MASTER) [](https://gitter.im/spring-projects/spring-integration?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
==================
|
|
|
|
# Code of Conduct
|
|
|
|
Please see our [Code of conduct](https://github.com/spring-projects/.github/blob/master/CODE_OF_CONDUCT.md).
|
|
|
|
# Reporting Security Vulnerabilities
|
|
|
|
Please see our [Security policy](https://github.com/spring-projects/spring-integration/security/policy).
|
|
|
|
|
|
# Checking out and Building
|
|
|
|
To check out the project and build from the source, do the following:
|
|
|
|
git clone git://github.com/spring-projects/spring-integration.git
|
|
cd spring-integration
|
|
./gradlew build
|
|
|
|
**NOTE:** While Spring Integration runs with Java SE 8 or higher, a Java 11 compiler is required to build the project.
|
|
|
|
To build and install jars into your local Maven cache:
|
|
|
|
./gradlew publishToMavenLocal
|
|
|
|
To build api Javadoc (results will be in `build/api`):
|
|
|
|
./gradlew api
|
|
|
|
To build the reference documentation (results will be in `build/docs/asciidoc` and `build/docs/asciidocPdf`):
|
|
|
|
./gradlew reference
|
|
|
|
To build complete distribution including `-dist`, `-docs`, and `-schema` zip files (results will be in `build/distributions`):
|
|
|
|
./gradlew dist
|
|
|
|
# Using Eclipse
|
|
|
|
To generate Eclipse metadata (.classpath and .project files), do the following:
|
|
|
|
./gradlew eclipse
|
|
|
|
Once complete, you may then import the projects into Eclipse as usual:
|
|
|
|
*File -> Import -> Existing projects into workspace*
|
|
|
|
Browse to the *'spring-integration'* root directory. All projects should import
|
|
free of errors.
|
|
|
|
# Using IntelliJ IDEA
|
|
|
|
To generate IDEA metadata (.iml and .ipr files), do the following:
|
|
|
|
./gradlew idea
|
|
|
|
See also [Contributor Guidelines](https://github.com/spring-projects/spring-integration/blob/master/CONTRIBUTING.adoc).
|
|
|
|
# Resources
|
|
|
|
For more information, please visit the Spring Integration website at:
|
|
[https://projects.spring.io/spring-integration](https://projects.spring.io/spring-integration/)
|