DATAKV-264 - Introduce Jenkins.

2019-05-30 09:22:05 -05:00
parent f7472464cf
commit 8d17cac18e
7 changed files with 689 additions and 4 deletions
--- a/README.adoc
+++ b/README.adoc
@@ -1,8 +1,12 @@
-# Spring Data Key Value
-
 image:https://travis-ci.org/spring-projects/spring-data-keyvalue.svg?branch=master["Build Status", link="https://travis-ci.org/spring-projects/spring-data-keyvalue"]

-The primary goal of the http://projects.spring.io/spring-data[Spring Data] project is to make it easier to build Spring-powered applications that use data access technologies. This module provides infrastructure components to build repository abstractions for stores dealing with Key/Value pairs and ships with a default `java.util.Map` based implementation.
+image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-keyvalue%2Fmaster&subject=Moore%20(master)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-keyvalue/]
+image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-keyvalue%2F2.1.x&subject=Lovelace%20(2.1.x)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-keyvalue/]
+image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-keyvalue%2F1.2.x&subject=Ingalls%20(2.1.x)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-keyvalue/]
+
+# Spring Data Key Value
+
+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 data access technologies. This module provides infrastructure components to build repository abstractions for stores dealing with Key/Value pairs and ships with a default `java.util.Map` based implementation.

 ## Features

@@ -92,4 +96,43 @@ Here are some ways for you to get involved in the community:
 * Watch for upcoming articles on Spring by http://spring.io/blog[subscribing] to spring.io.

 Before we accept a non-trivial patch or pull request we will need you to https://cla.pivotal.io/sign/spring[sign the Contributor License Agreement]. Signing the contributor’s agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. If you forget to do so, you'll be reminded when you submit a pull request.
- Active contributors might be asked to join the core team, and given the ability to merge pull requests.
+ Active contributors might be asked to join the core team, and given the ability to merge pull requests.
+
+= 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-keyvalue-github adoptopenjdk/openjdk8:latest /bin/bash`
+
+This will launch the Docker image and mount your source code at `spring-data-keyvalue-github`.
+
+2. `cd spring-data-keyvalue-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-keyvalue-github adoptopenjdk/openjdk8:latest /bin/bash`
+
+This will launch the Docker image and mount your source code at `spring-data-keyvalue-github`.
+
+2. `cd spring-data-keyvalue-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.
+