Generate javadoc from a project in a subdirectory

[releng/global-jjb.git] / releasenotes / notes / extend-javadoc-mvn-dir-7324879c369a9d8b.yaml

diff --git a/releasenotes/notes/extend-javadoc-mvn-dir-7324879c369a9d8b.yaml b/releasenotes/notes/extend-javadoc-mvn-dir-7324879c369a9d8b.yaml
new file mode 100644 (file)
index 0000000..af276d1
--- /dev/null
+++ b/releasenotes/notes/extend-javadoc-mvn-dir-7324879c369a9d8b.yaml
@@ -0,0 +1,17 @@
+---
+upgrade:
+  - |
+    Projects using macros lf-maven-javadoc-publish or lf-maven-javadoc-verify
+    (i.e., using job templates gerrit-maven-javadoc-publish, github-maven-javadoc-publish,
+    gerrit-maven-javadoc-verify or github-maven-javadoc-verify) must ensure the
+    maven -f option is not used in config parameter mvn-params.
+features:
+  - |
+    Generate javadoc from a project in a subdirectory, which lifts the
+    assumption that all files are in the git repository root.
+    Extend maven-javadoc publish and javadoc-verify templates with mvn-dir
+    configuration parameter (like tox-dir), defaults to '.' to keep existing
+    behavior.
+    Extend maven-javadoc-generate.sh script to invoke mvn with the -f option
+    and use the directory name when archiving the generated HTML.
+    Document the new configuration parameter.