diff --git a/CI.adoc b/CI.adoc new file mode 100644 index 000000000..b73628ded --- /dev/null +++ b/CI.adoc @@ -0,0 +1,45 @@ += Continuous Integration + +image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-commons%2Fmaster&subject=Moore%20(master)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-commons/] +image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-commons%2F2.1.x&subject=Lovelace%20(2.1.x)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-commons/] +image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-commons%2F1.13.x&subject=Ingalls%20(1.13.x)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-commons/] + +== Running CI tasks locally + +Since this pipeline is purely Docker-based, it's easy to: + +* Debug what went wrong on your local machine. +* Test out a a tweak to your `test.sh` script before sending it out. +* Experiment against a new image before submitting your pull request. + +All of these use cases are great reasons to essentially run what the CI server does on your local machine. + +IMPORTANT: To do this you must have Docker installed on your machine. + +1. `docker run -it --mount type=bind,source="$(pwd)",target=/spring-data-commons-github adoptopenjdk/openjdk8:latest /bin/bash` ++ +This will launch the Docker image and mount your source code at `spring-data-commons-github`. ++ +2. `cd spring-data-commons-github` ++ +Next, run your tests from inside the container: ++ +3. `./mvnw clean dependency:list test -Dsort` (or whatever profile you need to test out) + +Since the container is binding to your source, you can make edits from your IDE and continue to run build jobs. + +If you need to test the `build.sh` script, do this: + +1. `docker run -it --mount type=bind,source="$(pwd)",target=/spring-data-commons-github adoptopenjdk/openjdk8:latest /bin/bash` ++ +This will launch the Docker image and mount your source code at `spring-data-commons-github`. ++ +2. `cd spring-data-commons-github` ++ +Next, try to package everything up from inside the container: ++ +3. `./mvnw -Pci,snapshot -Dmaven.test.skip=true clean deploy` + +IMPORTANT: This will attempt to deploy to artifactory, but without credentials, it will fail, leaving you simply with a built artifact. + +NOTE: Docker containers can eat up disk space fast! From time to time, run `docker system prune` to clean out old images. diff --git a/README.adoc b/README.adoc new file mode 100644 index 000000000..44e8ba58b --- /dev/null +++ b/README.adoc @@ -0,0 +1,105 @@ += Spring Data Commons image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-commons%2Fmaster&subject=Build[link=https://jenkins.spring.io/view/SpringData/job/spring-data-commons/] https://gitter.im/spring-projects/spring-data[image:https://badges.gitter.im/spring-projects/spring-data.svg[Gitter]] + +https://projects.spring.io/spring-data/[Spring Data Commons] is part of the umbrella Spring Data project that provides shared infrastructure across the Spring Data projects. It contains technology neutral repository interfaces as well as a metadata model for persisting Java classes. + +Our primary goals are: + +* Powerful Repository and custom object-mapping abstractions +* Support for cross-store persistence +* Dynamic query generation from query method names +* Implementation domain base classes providing basic properties +* Support for transparent auditing (created, last changed) +* Possibility to integrate custom repository code +* Easy Spring integration with custom namespace + +== Code of Conduct + +This project is governed by the link:CODE_OF_CONDUCT.adoc[Spring Code of Conduct]. By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io. + +== Getting Started + +=== Maven configuration + +Add the Maven dependency: + +[source,xml] +---- + + org.springframework.data + spring-data-commons + ${version}.RELEASE + +---- + +If you'd rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version. + +[source,xml] +---- + + org.springframework.data + spring-data-commons + ${version}.BUILD-SNAPSHOT + + + + spring-libs-snapshot + Spring Snapshot Repository + https://repo.spring.io/libs-snapshot + +---- + +== Getting Help + +Having trouble with Spring Data? We’d love to help! + +* Check the +https://docs.spring.io/spring-data/commons/docs/current/reference/html/[reference documentation], and https://docs.spring.io/spring-data/commons/docs/current/api/[Javadocs]. +* Learn the Spring basics – Spring Data builds on Spring Framework, check the https://spring.io[spring.io] web-site for a wealth of reference documentation. +If you are just starting out with Spring, try one of the https://spring.io/guides[guides]. +* If you are upgrading, check out the https://docs.spring.io/spring-data/commons/docs/current/changelog.txt[changelog] for "`new and noteworthy`" features. +* Ask a question - we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-data[`spring-data`]. +You can also chat with the community on https://gitter.im/spring-projects/spring-data[Gitter]. +* Report bugs with Spring Data Commons at https://jira.spring.io/browse/DATACMNS[jira.spring.io/browse/DATACMNS]. + +== Reporting Issues + +Spring Data uses JIRA as issue tracking system to record bugs and +feature requests. If you want to raise an issue, please follow the +recommendations below: + +* Before you log a bug, please search the +https://jira.spring.io/browse/DATACMNS[issue tracker] to see if someone has already reported the problem. +* If the issue doesn’t already exist, https://jira.spring.io/browse/DATACMNS[create a new issue]. +* Please provide as much information as possible with the issue report, we like to know the version of Spring Data that you are using and JVM +version. +* If you need to paste code, or include a stack trace use JIRA `{code}…{code}` escapes before and after your text. +* If possible try to create a test-case or project that replicates the issue. Attach a link to your code or a compressed file containing your code. + +== Building from Source + +You don’t need to build from source to use Spring Data (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring Data can be easily built with the https://github.com/takari/maven-wrapper[maven wrapper]. +You also need JDK 1.8. + +[source,bash] +---- + $ ./mvnw clean install +---- + +If you want to build with the regular `mvn` command, you will need https://maven.apache.org/run-maven/index.html[Maven v3.5.0 or above]. + +_Also see link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] if you wish to submit pull requests, and in particular please sign the https://cla.pivotal.io/sign/spring[Contributor’s Agreement] before your first change, is trivial._ + +=== Building reference documentation + +Building the documentation builds also the project without running tests. + +[source,bash] +---- + $ ./mvnw clean install -Pdistribute +---- + +The generated documentation is available from `target/site/reference/html/index.html`. + +== License + +Spring Data Commons is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].