From 25919195edcf4061345d3d37869d648b175fd465 Mon Sep 17 00:00:00 2001
From: Benjamin Eckstein <13351939+benjamineckstein@users.noreply.github.com>
Date: Wed, 22 Jan 2020 09:20:16 +0100
Subject: [PATCH] TSK-369: Fix rest documentation
---
.travis.yml | 1 +
ci/compile.sh | 4 ++--
ci/test.sh | 8 ++++----
ci/verify_docs_jar.sh | 1 +
pom.xml | 5 +++++
rest/taskana-rest-spring/pom.xml | 6 ++++++
6 files changed, 19 insertions(+), 6 deletions(-)
diff --git a/.travis.yml b/.travis.yml
index b0c69cc96..6fff23779 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -43,6 +43,7 @@ env:
- DB=POSTGRES_10_4
install: skip
+# include SONAR_PROJECT_KEY as a second parameter if this is not a pull request
script: ci/test.sh "$DB" "$([ "false" = "$TRAVIS_PULL_REQUEST" ] && echo "$SONAR_PROJECT_KEY")"
before_cache: rm -rf "$HOME/.m2/repository/pro/taskana"
diff --git a/ci/compile.sh b/ci/compile.sh
index 5c914fdf9..b89df6658 100755
--- a/ci/compile.sh
+++ b/ci/compile.sh
@@ -37,12 +37,12 @@ function main() {
;;
REST)
set -x
- mvn -q install -B -f $REL/.. -pl :taskana-spring -am -DskipTests -Dcheckstyle.skip -Dmaven.javadoc.skip
+ mvn -q install -B -f $REL/.. -pl :taskana-spring -am -Dasciidoctor.skip -DskipTests -Dcheckstyle.skip -Dmaven.javadoc.skip
mvn -q test-compile -B -f $REL/../rest
;;
HISTORY)
set -x
- mvn -q install -B -f $REL/.. -pl :taskana-rest-spring -am -DskipTests -Dcheckstyle.skip -Dmaven.javadoc.skip
+ mvn -q install -B -f $REL/.. -pl :taskana-rest-spring -am -Dasciidoctor.skip -DskipTests -Dcheckstyle.skip -Dmaven.javadoc.skip
mvn -q test-compile -B -f $REL/../history
;;
esac
diff --git a/ci/test.sh b/ci/test.sh
index d8e884e0a..2a54a69be 100755
--- a/ci/test.sh
+++ b/ci/test.sh
@@ -35,8 +35,8 @@ function main() {
set -x
eval "$REL/prepare_db.sh '$1'"
# We can not use the fance '-f' maven option due to a bug in arquillian. See https://issues.jboss.org/browse/THORN-2049
- (cd $REL/.. && mvn -q install -B -T 4C -am -Pcoverage -Dmaven.javadoc.skip -Dcheckstyle.skip)
-
+ (cd $REL/.. && mvn -q install -B -T 4C -am -Pcoverage -Dcheckstyle.skip)
+ eval "$REL/verify_docs_jar.sh"
# disabling sonarqube for PRs because it's not supported yet. See https://jira.sonarsource.com/browse/MMF-1371
if [ -n "$2" ]; then
#-Pcoverage to activate jacoco and test coverage reports
@@ -53,7 +53,7 @@ function main() {
set -x
eval "$REL/prepare_db.sh '$1'"
### INSTALL ###
- mvn -q install -B -f $REL/.. -P postgres -am -T 4C -pl :taskana-rest-spring-example-wildfly -DskipTests -Dmaven.javadoc.skip -Dcheckstyle.skip
+ mvn -q install -B -f $REL/.. -P postgres -am -T 4C -pl :taskana-rest-spring-example-wildfly -Dasciidoctor.skip -DskipTests -Dmaven.javadoc.skip -Dcheckstyle.skip
### TEST ###
mvn -q verify -B -f $REL/.. -Dmaven.javadoc.skip -Dcheckstyle.skip -pl :taskana-core
@@ -63,7 +63,7 @@ function main() {
HISTORY)
set -x
### INSTALL ###
- mvn -q install -B -f $REL/.. -am -T 4C -pl :taskana-rest-spring -DskipTests -Dmaven.javadoc.skip -Dcheckstyle.skip
+ mvn -q install -B -f $REL/.. -am -T 4C -pl :taskana-rest-spring -Dasciidoctor.skip -DskipTests -Dmaven.javadoc.skip -Dcheckstyle.skip
### TEST ###
mvn -q verify -B -f $REL/../history -Dmaven.javadoc.skip -Dcheckstyle.skip
diff --git a/ci/verify_docs_jar.sh b/ci/verify_docs_jar.sh
index 84a79547c..97cfbe3ed 100755
--- a/ci/verify_docs_jar.sh
+++ b/ci/verify_docs_jar.sh
@@ -1,6 +1,7 @@
#!/bin/bash
set -e #fail fast
+#check that first dir has same amount of files as second dir
function verifyDocs() {
test -d "$1"
test $(find "$1" | wc -l) -eq $(grep "$2" <<<"$JAR_CONTENT" | wc -l)
diff --git a/pom.xml b/pom.xml
index 959092420..310832ff0 100644
--- a/pom.xml
+++ b/pom.xml
@@ -303,6 +303,11 @@
${version.maven.surefire}
${argLine}
+
+
+ **/*Test.java
+ **/*Documentation.java
+
diff --git a/rest/taskana-rest-spring/pom.xml b/rest/taskana-rest-spring/pom.xml
index a9a492ebe..8dc9f1325 100644
--- a/rest/taskana-rest-spring/pom.xml
+++ b/rest/taskana-rest-spring/pom.xml
@@ -180,6 +180,12 @@
${basedir}/target/generated-snippets
shared
+
+ false
+
+ ERROR
+
+