From 8671c2eeb23b351fec65068e07ea8dcd982ff45c Mon Sep 17 00:00:00 2001 From: "Lott, Christopher (cl778h)" Date: Wed, 15 Jan 2020 15:17:03 -0500 Subject: [PATCH] Revise javadoc script dash-f argument Revise shell script maven-javadoc-generate.sh to supply -f argument to maven with absolute path determined by readlink. This works around javadoc:aggregate behavior of silently generating no files in parent project if invoked as "-f ." Change-Id: I6856756539dd8aee80d8841dfbfe9efb76b8cb93 Issue-Id: RELENG-2672 Signed-off-by: Lott, Christopher (cl778h) --- releasenotes/notes/maven-javadoc-dash-f-87c652e0363b3c6d.yaml | 7 +++++++ shell/maven-javadoc-generate.sh | 8 ++++++-- 2 files changed, 13 insertions(+), 2 deletions(-) create mode 100644 releasenotes/notes/maven-javadoc-dash-f-87c652e0363b3c6d.yaml diff --git a/releasenotes/notes/maven-javadoc-dash-f-87c652e0363b3c6d.yaml b/releasenotes/notes/maven-javadoc-dash-f-87c652e0363b3c6d.yaml new file mode 100644 index 00000000..bb3e5ce4 --- /dev/null +++ b/releasenotes/notes/maven-javadoc-dash-f-87c652e0363b3c6d.yaml @@ -0,0 +1,7 @@ +--- +fixes: + - | + Revise shell script maven-javadoc-generate.sh to supply -f + argument to maven with argument translated by call to readlink. + This works around the javadoc:aggregate behavior of silently + doing nothing if invoked "-f ." diff --git a/shell/maven-javadoc-generate.sh b/shell/maven-javadoc-generate.sh index 137f4d7a..0f1cac3c 100644 --- a/shell/maven-javadoc-generate.sh +++ b/shell/maven-javadoc-generate.sh @@ -21,19 +21,23 @@ mkdir -p "$WORKSPACE/archives" export MAVEN_OPTS +# use absolute path as workaround for javadoc:aggregate +# silent failure on relative path, for example "-f ." +maven_dir_abs=$(readlink -f $MAVEN_DIR) + # Disable SC2086 because we want to allow word splitting for $MAVEN_* parameters. # shellcheck disable=SC2086 # Use -x via subshell to show maven invocation details in the log (set -x $MVN clean install javadoc:aggregate \ + -f "$maven_dir_abs" \ -e -Pq -Dmaven.javadoc.skip=false \ -DskipTests=true \ -Dcheckstyle.skip=true \ -Dfindbugs.skip=true \ --global-settings "$GLOBAL_SETTINGS_FILE" \ --settings "$SETTINGS_FILE" \ - -f "$MAVEN_DIR" \ - $MAVEN_OPTIONS $MAVEN_PARAMS \ + $MAVEN_OPTIONS $MAVEN_PARAMS ) mv "$WORKSPACE/$MAVEN_DIR/target/site/apidocs" "$JAVADOC_DIR" -- 2.16.6