Skip to content

Commit

Permalink
Fix javadoc:jar generation and add it in the verify goals (#115)
Browse files Browse the repository at this point in the history
* add javadoc:jar verify goal
* build with java11
* fix javadoc generation

---------

Signed-off-by: Olivier Lamy <[email protected]>
  • Loading branch information
olamy authored Nov 27, 2023
1 parent 18a51cd commit 1f343ee
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 17 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/maven-verify-3.9.x.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
with:
maven-args: '-D"maven.test.redirectTestOutputToFile=false -Pmaven3"'
maven-matrix: '[ "3.9.5", "4.0.0-alpha-8" ]'
matrix-exclude: >
[
{"jdk": "8"}
]
jdk-matrix: '[ "11", "17" ]'
ff-goal: '-P run-its verify javadoc:jar'
verify-goal: '-P run-its verify javadoc:jar'

7 changes: 3 additions & 4 deletions .github/workflows/maven-verify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ jobs:
with:
maven-args: '-D"maven.test.redirectTestOutputToFile=false"'
maven-matrix: '[ "3.9.5", "4.0.0-alpha-8" ]'
matrix-exclude: >
[
{"jdk": "8"}
]
jdk-matrix: '[ "11", "17" ]'
ff-goal: '-P run-its verify javadoc:jar'
verify-goal: '-P run-its verify javadoc:jar'
16 changes: 7 additions & 9 deletions src/main/mdo/build-cache-config.mdo
Original file line number Diff line number Diff line change
Expand Up @@ -816,26 +816,24 @@ under the License.
</class>
<class>
<name>Exclude</name>
<description><![CDATA[A file or a directory path to exclude from the checksum computation. Relative path are relative to each module basedir.<br/>
<description><![CDATA[<p>A file or a directory path to exclude from the checksum computation. Relative path are relative to each module basedir.</p>
When referring to a directory, additional properties help adjust the scope of the exclusion:
<ul>
<li>glob - only entries matching this <a href="https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob">glob pattern</a> are excluded</li>
<li>entryType - type of entries excluded from the scan</li>
<li>matcherType - entry property on which the glob matching is applied</li>
</ul>
By default, targeting a directory excludes everything underneath it.<br/>
<br/>
<p>By default, targeting a directory excludes everything underneath it.</p>
Examples :
<ul>
<li><code>&lt;exclude&gt;src/main/doc&lt;/exclude&gt;</code> : excludes everything under : ${project.basedir}/src/main/doc</li>
<li><code>&lt;exclude&gt;src/main/java/package-info.java&lt;/exclude&gt;</code> : excludes this file : ${project.basedir}/src/main/java/package-info.java</li>
<li><code>&lt;exclude glob="package-info.java"&gt;&lt;/exclude&gt;</code> : excludes all the files named package-info.java</li>
<li><code>&lt;exclude glob="src/main/resources&#x2F;**.txt" entryType="FILE" matcherType="PATH" &gt;&lt;/exclude&gt;</code> : excludes all the text files located under the "resources" folder</li>
</ul>
<br/>
Exclude elements can also be added per project with the use of <a href="parameters.html#project-level-properties">maven properties.</a><br/>
<br/><br/>

<p>
Exclude elements can also be added per project with the use of <a href="parameters.html#project-level-properties">maven properties.</a>
</p>
]]></description>
<fields>
<field xml.content="true">
Expand Down Expand Up @@ -865,8 +863,8 @@ under the License.
</class>
<class>
<name>Include</name>
<description><![CDATA[A file or a directory path to add to checksum computation. Relative path are relative to each module basedir.<br/><br/>
Include elements can also be added per project with the use of <a href="parameters.html#project-level-properties">maven properties.</a><br/><br/>
<description><![CDATA[A <p>file or a directory path to add to checksum computation. Relative path are relative to each module basedir.</p>
<p>Include elements can also be added per project with the use of <a href="parameters.html#project-level-properties">maven properties.</a></p>
]]></description>
<fields>
<field xml.content="true">
Expand Down

0 comments on commit 1f343ee

Please sign in to comment.