Fix: Workaround for yaml multiline string
[releng/global-jjb.git] / releasenotes / notes / extend-javadoc-mvn-dir-7324879c369a9d8b.yaml
1 ---
2 upgrade:
3   - |
4     Projects using macros lf-maven-javadoc-publish or lf-maven-javadoc-verify
5     (i.e., using job templates gerrit-maven-javadoc-publish, github-maven-javadoc-publish,
6     gerrit-maven-javadoc-verify or github-maven-javadoc-verify) must ensure the
7     maven -f option is not used in config parameter mvn-params.
8 features:
9   - |
10     Generate javadoc from a project in a subdirectory, which lifts the
11     assumption that all files are in the git repository root.
12     Extend maven-javadoc publish and javadoc-verify templates with mvn-dir
13     configuration parameter (like tox-dir), defaults to '.' to keep existing
14     behavior.
15     Extend maven-javadoc-generate.sh script to invoke mvn with the -f option
16     and use the directory name when archiving the generated HTML.
17     Document the new configuration parameter.