From c9307c449b6bf15c6839e251f7f8aa34093d6e08 Mon Sep 17 00:00:00 2001 From: Michael Simons Date: Thu, 11 Jul 2019 09:29:18 +0200 Subject: [PATCH] DATAGRAPH-1238 - Unify README. --- CI.adoc | 43 ++++++++ README.adoc | 281 ++++++++++++++++++++++------------------------------ 2 files changed, 163 insertions(+), 161 deletions(-) create mode 100644 CI.adoc diff --git a/CI.adoc b/CI.adoc new file mode 100644 index 000000000..2a142179b --- /dev/null +++ b/CI.adoc @@ -0,0 +1,43 @@ += Continuous Integration + +image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-neo4j%2Fmaster&subject=Moore%20(master)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-neo4j/] +image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-neo4j%2F5.1.x&subject=Lovelace%20(5.1.x)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-neo4j/] +image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-neo4j%2F4.2.x&subject=Ingalls%20(4.2.x)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-neo4j/] + += 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-neo4j-github adoptopenjdk/openjdk8:latest /bin/bash` ++ +This will launch the Docker image and mount your source code at `spring-data-neo4j-github`. ++ +2. `cd spring-data-neo4j-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 test building the artifact, do this: + +1. `docker run -it --mount type=bind,source="$(pwd)",target=/spring-data-neo4j-github adoptopenjdk/openjdk8:latest /bin/bash` ++ +This will launch the Docker image and mount your source code at `spring-data-neo4j-github`. ++ +2. `cd spring-data-neo4j-github` ++ +Next, try to package everything up from inside the container: ++ +3. `./mvnw -Pci,snapshot -Dmaven.test.skip=true clean package` + +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 index cdac5b79c..405ea9500 100644 --- a/README.adoc +++ b/README.adoc @@ -1,126 +1,19 @@ image:https://spring.io/badges/spring-data-neo4j/ga.svg[title=Spring Data Neo4j,link=https://projects.spring.io/spring-data-neo4j#quick-start] image:https://spring.io/badges/spring-data-neo4j/snapshot.svg[title=Spring Data Neo4j,link=https://projects.spring.io/spring-data-neo4j#quick-start] -image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-neo4j%2Fmaster&subject=Moore%20(master)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-neo4j/] -image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-neo4j%2F5.1.x&subject=Lovelace%20(5.1.x)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-neo4j/] -image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-neo4j%2F4.2.x&subject=Ingalls%20(4.2.x)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-neo4j/] - = Spring Data Neo4j The primary goal of the https://projects.spring.io/spring-data[Spring Data] project is to make it easier to build Spring-powered applications that use new data access technologies such as non-relational databases, map-reduce frameworks, and cloud based data services. The Spring Data Neo4j project aims to provide a familiar and consistent Spring-based programming model for integrating with the https://neo4j.com/[Neo4j] Graph Database. -=== Features +== Code of Conduct -* Automatic mapping of annotated domain entities for nodes and relationships; -* Powerful CRUD based repositories with provided, derived, and annotated finder methods; -* Integration with Spring's comprehensive Transaction management; -* Agnostic communication with Neo4j through a variety of transport mechanisms (embedded, http, https://neo4j.com/developer/language-guides/#bolt-drivers[bolt]); -* Integration into Spring Data REST; -* Seamless integration with Spring Boot. +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 - -== Documentation & Getting Help - -This README is the best place to start learning about the features of Spring Data Neo4j. - -To learn more refer to: - -* the https://docs.spring.io/spring-data/neo4j/docs/5.0.x/reference/html/[Reference Manual]; -* the https://github.com/neo4j-examples/sdn-university[sample project: SDN University]. More example projects for Spring Data Neo4j are available in the https://github.com/neo4j-examples?query=sdn4[Neo4j-Examples] repository -* The main https://projects.spring.io/spring-data-neo4j[Spring project site] contains links to basic project information such as source code, JavaDocs, Issue tracking, etc. -* the https://docs.spring.io/spring-data/neo4j/docs/5.0.x/api/[Javadocs]; -* for more detailed questions, use https://stackoverflow.com/questions/tagged/spring-data-neo4j-5[Spring Data Neo4j on StackOverflow] - -If you are new to Spring as well as to Spring Data, look for information about https://spring.io/projects[Spring projects]. - -== Quick start - - -Add the Maven dependency: - -[source,xml] ----- - - org.springframework.data - spring-data-neo4j - ${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-neo4j - ${version}.BUILD-SNAPSHOT - - - - - spring-libs-snapshot - true - Springframework Maven SNAPSHOT Repository - https://repo.spring.io/libs-snapshot - ----- - -TIP: You can check out how to get setup with Gradle in the the https://docs.spring.io/spring-data/data-neo4j/docs/current/reference/html/[Reference Manual]. - - -Configure Spring Data Neo4j in your application using JavaConfig bean configuration - -[source,java] ----- -@Configuration -@ComponentScan(basePackages = "org.example.person.services",...) -@EnableNeo4jRepositories(basePackages = "com.example.person.repository",...) -@EnableTransactionManagement -public class MyConfiguration { - - @Bean - public SessionFactory sessionFactory() { - // with domain entity base package(s) - return new SessionFactory(configuration(), "com.example.person.domain",...); - } - - @Bean - public org.neo4j.ogm.config.Configuration configuration() { - org.neo4j.ogm.config.Configuration configuration = new org.neo4j.ogm.config.Configuration.Builder() - .uri("bolt://localhost") - .credentials("user", "secret") - .build(); - return configuration; - } - - @Bean - public Neo4jTransactionManager transactionManager() { - return new Neo4jTransactionManager(sessionFactory()); - } -} ----- - -Spring Data Neo4j provides support for connecting to all of Neo4j's java drivers: - -* Bolt -* HTTP -* Embedded - -Spring Data Neo4j will attempt to auto-configure itself using a file called `ogm.properties`, which it expects to find on root of the classpath. Here we will configure the HTTP Driver. - -[source,java] ----- -URI=http://user:password@localhost:7474 ----- - -The application can be configured programmatically as well, please consult https://docs.spring.io/spring-data/neo4j/docs/5.0.x/reference/html/#reference.getting_started.spring-configuration[the reference guide] for more information. - - -Annotate an entity: +Here is a quick teaser of an application using Spring Data Repositories in Java: [source,java] ---- @@ -137,15 +30,7 @@ public class Person { private void knows(Person friend) { friends.add(friend); } } ----- - -To simplify the creation of data repositories Spring Data Neo4j provides a generic repository programming model. It will automatically create a repository proxy for you that adds implementations of finder methods you specify on an interface. - -For example, given the Person class above, a PersonRepository interface that can query for Person by name and when the name matches a like expression is shown below: - -[source,java] ----- @Repository public interface PersonRepository extends Neo4jRepository { @@ -153,14 +38,7 @@ public interface PersonRepository extends Neo4jRepository { List findByNameLike(String name); } ----- -The queries issued on execution will be derived from the method name. - -Typically you will want to call your domain objects and repositories from services. In this Service we find the repository interface and register a proxy object in the container: - -[source,java] ----- @Service public class MyService { @@ -191,54 +69,135 @@ public class MyService { } } } + +@Configuration +@ComponentScan +@EnableNeo4jRepositories +@EnableTransactionManagement +public class MyConfiguration { + + @Bean + public SessionFactory sessionFactory(org.neo4j.ogm.config.Configuration configuration) { + // with domain entity base package(s) + return new SessionFactory(configuration, "com.example.person.domain"); + } + + @Bean + public org.neo4j.ogm.config.Configuration configuration() { + org.neo4j.ogm.config.Configuration configuration = new org.neo4j.ogm.config.Configuration.Builder() + .uri("bolt://localhost") + .credentials("user", "secret") + .build(); + return configuration; + } + + @Bean + public Neo4jTransactionManager transactionManager() { + return new Neo4jTransactionManager(sessionFactory()); + } +} ---- -== Contributing to Spring Data Neo4j +=== Maven configuration -There are dedicated, mandatory https://github.com/spring-projects/spring-data-build/blob/master/CONTRIBUTING.adoc[contribution guidelines] for all Spring Data projects. +Add the Maven dependency: -Here are some ways for you to get involved in the community: +[source,xml] +---- + + org.springframework.data + spring-data-neo4j + ${version}.RELEASE + +---- -* Get involved with Spring Data Neo4j community on the https://groups.google.com/group/neo4j[Neo4j Google Group] and by helping on https://stackoverflow.com/questions/tagged/spring-data-neo4j[StackOverflow]. -* Create https://jira.spring.io/browse/DATAGRAPH[JIRA] tickets for bugs and new features and comment and vote on the ones that you are interested in. -* Github is for social coding: if you want to write code, we encourage contributions through *pull requests* from a fork of this repository. - If you want to contribute code this way, please read the https://github.com/spring-projects/spring-data-build/blob/master/CONTRIBUTING.adoc[contribution guidelines] for details. +If you'd rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version. -= Running CI tasks locally +[source,xml] +---- + + org.springframework.data + spring-data-neo4j + ${version}.BUILD-SNAPSHOT + -Since this pipeline is purely Docker-based, it's easy to: + + spring-libs-snapshot + Spring Snapshot Repository + https://repo.spring.io/libs-snapshot + +---- -* 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. +Please find the setup for Gradle based projects in the the https://docs.spring.io/spring-data/data-neo4j/docs/current/reference/html/[Reference Manual]. -All of these use cases are great reasons to essentially run what the CI server does on your local machine. +Spring Data Neo4j provides support for connecting to all of Neo4j's java drivers: -IMPORTANT: To do this you must have Docker installed on your machine. +* Bolt +* HTTP +* Embedded -1. `docker run -it --mount type=bind,source="$(pwd)",target=/spring-data-neo4j-github adoptopenjdk/openjdk8:latest /bin/bash` -+ -This will launch the Docker image and mount your source code at `spring-data-neo4j-github`. -+ -2. `cd spring-data-neo4j-github` -+ -Next, run your tests from inside the container: -+ -3. `./mvnw clean dependency:list test -Dsort` (or whatever profile you need to test out) +Depending on your need, you'll have to add one additional Neo4j-OGM module. +Please refer to the reference linked above. -Since the container is binding to your source, you can make edits from your IDE and continue to run build jobs. +== Getting Help -If you test building the artifact, do this: +Having trouble with Spring Data? We’d love to help! -1. `docker run -it --mount type=bind,source="$(pwd)",target=/spring-data-neo4j-github adoptopenjdk/openjdk8:latest /bin/bash` -+ -This will launch the Docker image and mount your source code at `spring-data-neo4j-github`. -+ -2. `cd spring-data-neo4j-github` -+ -Next, try to package everything up from inside the container: -+ -3. `./mvnw -Pci,snapshot -Dmaven.test.skip=true clean package` +* Check the +https://docs.spring.io/spring-data/neo4j/docs/current/reference/html/[reference documentation], and https://docs.spring.io/spring-data/neo4j/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/neo4j/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/questions/tagged/spring-data-neo4j-5[spring-data-neo4j-5]. +* Report bugs with Spring Data Neo4j at https://jira.spring.io/browse/DATAGRAPH[jira.spring.io/browse/DATAGRAPH]. -NOTE: Docker containers can eat up disk space fast! From time to time, run `docker system prune` to clean out old images. +== 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/DATAGRAPH[issue tracker] to see if someone has already reported the problem. +* If the issue doesn’t already exist, https://jira.spring.io/browse/DATAGRAPH[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 non-trivial change._ + +=== 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`. + +== Guides + +The https://spring.io/[spring.io] site contains several guides that show how to use Spring Data step-by-step: + +* https://spring.io/guides/gs/accessing-data-neo4j/[Accessing Data with Neo4j] is a very basic guide that shows you how to create a simple application and how to access data using repositories. +* https://spring.io/guides/gs/accessing-neo4j-data-rest/[Accessing Neo4j Data with REST] is a guide to creating a REST web service exposing data stored in Neo4j through repositories. + +== Examples + +* https://github.com/spring-projects/spring-data-examples/[Spring Data Examples] contains example projects that explain specific features in more detail. + +== License + +Spring Data Neo4j is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].