From a2c9d5b9feb482ea70beb1198d230b132aa12341 Mon Sep 17 00:00:00 2001 From: Greg Turnquist Date: Tue, 14 May 2019 15:23:05 -0500 Subject: [PATCH] DATAREST-1380 - Introduce Jenkins. --- Jenkinsfile | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.adoc | 45 +++++++++++++++++++++++++++- ci/build.sh | 15 ---------- ci/build.yml | 20 ------------- ci/test.sh | 11 ------- ci/test.yml | 20 ------------- pom.xml | 41 +++++++++++++++++++++++++ 7 files changed, 170 insertions(+), 67 deletions(-) create mode 100644 Jenkinsfile delete mode 100755 ci/build.sh delete mode 100644 ci/build.yml delete mode 100755 ci/test.sh delete mode 100644 ci/test.yml diff --git a/Jenkinsfile b/Jenkinsfile new file mode 100644 index 000000000..09b42faaf --- /dev/null +++ b/Jenkinsfile @@ -0,0 +1,85 @@ +pipeline { + agent none + + triggers { + pollSCM 'H/10 * * * *' + upstream(upstreamProjects: "spring-data-cassandra/master,spring-data-elasticsearch/master,spring-data-gemfire/master,spring-data-geode/master,spring-data-jpa/master," + + "spring-data-ldap/master,spring-data-neo4j/master", threshold: hudson.model.Result.SUCCESS) + } + + options { + disableConcurrentBuilds() + } + + stages { + stage("Test") { + parallel { + stage("test: baseline") { + agent { + docker { + image 'adoptopenjdk/openjdk8:latest' + args '-v $HOME/.m2:/root/.m2' + } + } + steps { + sh "./mvnw clean dependency:list test -Dsort -B" + } + } + } + } + stage('Release to artifactory') { + when { + branch 'issue/*' + } + agent { + docker { + image 'adoptopenjdk/openjdk8:latest' + args '-v $HOME/.m2:/root/.m2' + } + } + + environment { + ARTIFACTORY = credentials('02bd1690-b54f-4c9f-819d-a77cb7a9822c') + } + + steps { + sh "USERNAME=${ARTIFACTORY_USR} PASSWORD=${ARTIFACTORY_PSW} ./mvnw -Pci,snapshot -Dmaven.test.skip=true clean deploy -B" + } + } + stage('Release to artifactory with docs') { + when { + branch 'master' + } + agent { + docker { + image 'adoptopenjdk/openjdk8:latest' + args '-v $HOME/.m2:/root/.m2' + } + } + + environment { + ARTIFACTORY = credentials('02bd1690-b54f-4c9f-819d-a77cb7a9822c') + } + + steps { + sh "USERNAME=${ARTIFACTORY_USR} PASSWORD=${ARTIFACTORY_PSW} ./mvnw -Pci,snapshot -Dmaven.test.skip=true clean deploy -B" + } + } + } + + post { + changed { + script { + slackSend( + color: (currentBuild.currentResult == 'SUCCESS') ? 'good' : 'danger', + channel: '#spring-data-dev', + message: "${currentBuild.fullDisplayName} - `${currentBuild.currentResult}`\n${env.BUILD_URL}") + emailext( + subject: "[${currentBuild.fullDisplayName}] ${currentBuild.currentResult}", + mimeType: 'text/html', + recipientProviders: [[$class: 'CulpritsRecipientProvider'], [$class: 'RequesterRecipientProvider']], + body: "${currentBuild.fullDisplayName} is reported as ${currentBuild.currentResult}") + } + } + } +} diff --git a/README.adoc b/README.adoc index fe8f613b2..a45814cf9 100644 --- a/README.adoc +++ b/README.adoc @@ -1,6 +1,10 @@ image:https://spring.io/badges/spring-data-rest/ga.svg[Spring Data REST, link="http://projects.spring.io/spring-data-rest/#quick-start"] image:https://spring.io/badges/spring-data-rest/snapshot.svg[Spring Data REST, link="http://projects.spring.io/spring-data-rest/#quick-start"] +image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-rest%2Fmaster&subject=Moore%20(master)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-rest/] +image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-rest%2F3.1.x&subject=Lovelace%20(3.1.x)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-rest/] +image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-rest%2F2.6.x&subject=Ingalls%20(2.6.x)[link=https://jenkins.spring.io/view/SpringData/job/spring-data-rest/] + = Spring Data REST The goal of the project is to provide a flexible and configurable mechanism for writing simple services that can be exposed over HTTP. @@ -31,4 +35,43 @@ Before we accept a non-trivial patch or pull request we will need you to https:/ === Note We disabled the github issues since we want to use https://jira.spring.io/browse/DATAREST[JIRA] as the only issue tracker. -All open existing issues have been automatically imported into JIRA, so nothing was lost :) \ No newline at end of file +All open existing issues have been automatically imported into JIRA, so nothing was lost :) + += 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-rest-github adoptopenjdk/openjdk8:latest /bin/bash` ++ +This will launch the Docker image and mount your source code at `spring-data-rest-github`. ++ +2. `cd spring-data-rest-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-rest-github adoptopenjdk/openjdk8:latest /bin/bash` ++ +This will launch the Docker image and mount your source code at `spring-data-rest-github`. ++ +2. `cd spring-data-rest-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/ci/build.sh b/ci/build.sh deleted file mode 100755 index 078a06edf..000000000 --- a/ci/build.sh +++ /dev/null @@ -1,15 +0,0 @@ -#!/usr/bin/env sh - -set -euo pipefail - -[[ -d $PWD/maven && ! -d $HOME/.m2 ]] && ln -s $PWD/maven $HOME/.m2 - -spring_data_rest_artifactory=$(pwd)/spring-data-rest-artifactory - -rm -rf $HOME/.m2/repository/org/springframework/data 2> /dev/null || : - -cd spring-data-rest-github - -./mvnw deploy \ - -Dmaven.test.skip=true \ - -DaltDeploymentRepository=distribution::default::file://${spring_data_rest_artifactory} \ diff --git a/ci/build.yml b/ci/build.yml deleted file mode 100644 index 8268cb3ba..000000000 --- a/ci/build.yml +++ /dev/null @@ -1,20 +0,0 @@ ---- -platform: linux - -image_resource: - type: docker-image - source: - repository: openjdk - tag: 8-jdk-alpine - -inputs: -- name: spring-data-rest-github - -outputs: -- name: spring-data-rest-artifactory - -caches: -- path: maven - -run: - path: spring-data-rest-github/ci/build.sh diff --git a/ci/test.sh b/ci/test.sh deleted file mode 100755 index a078c82b9..000000000 --- a/ci/test.sh +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env sh - -set -euo pipefail - -[[ -d $PWD/maven && ! -d $HOME/.m2 ]] && ln -s $PWD/maven $HOME/.m2 - -rm -rf $HOME/.m2/repository/org/springframework/data 2> /dev/null || : - -cd spring-data-rest-github - -./mvnw clean dependency:list test -P${PROFILE} -Dsort diff --git a/ci/test.yml b/ci/test.yml deleted file mode 100644 index ad5105b1a..000000000 --- a/ci/test.yml +++ /dev/null @@ -1,20 +0,0 @@ ---- -platform: linux - -image_resource: - type: docker-image - source: - repository: openjdk - tag: 8-jdk-alpine - -inputs: -- name: spring-data-rest-github - -outputs: -- name: spring-data-rest-artifactory - -caches: -- path: maven - -run: - path: spring-data-rest-github/ci/test.sh diff --git a/pom.xml b/pom.xml index ba19eaaea..32090c507 100644 --- a/pom.xml +++ b/pom.xml @@ -82,6 +82,47 @@ + + snapshot + + + + + org.jfrog.buildinfo + artifactory-maven-plugin + 2.6.1 + false + + + build-info + + publish + + + + {{BUILD_URL}} + + + spring-data-rest + spring-data-rest + false + *:*:*:*@zip + + + https://repo.spring.io + {{USERNAME}} + {{PASSWORD}} + libs-snapshot-local + libs-snapshot-local + + + + + + + + + release