Skip to content

Commit cf36b63

Browse files
Update sitedocs for branch main
1 parent 8abbae0 commit cf36b63

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

doc/main/tycho-extras/tycho-version-bump-plugin/update-target-mojo.html

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,11 +159,26 @@ <h2>Optional Parameters</h2>
159159
<td><code>-</code></td>
160160
<td>No description.<br /><strong>User Property</strong>: <code>project</code></td></tr>
161161
<tr class="b">
162+
<td><a href="#reportFileName"><code>&lt;reportFileName&gt;</code></a></td>
163+
<td><code>File</code></td>
164+
<td><code>-</code></td>
165+
<td>No description.<br /><strong>Default</strong>: <code>${project.build.directory}/targetUpdates.md</code><br /><strong>User Property</strong>: <code>tycho.updatetarget.report</code></td></tr>
166+
<tr class="a">
167+
<td><a href="#reportPreamble"><code>&lt;reportPreamble&gt;</code></a></td>
168+
<td><code>String</code></td>
169+
<td><code>-</code></td>
170+
<td>No description.<br /><strong>Default</strong>: <code>Please review the changes and merge if appropriate, or cherry pick individual updates.</code><br /><strong>User Property</strong>: <code>tycho.updatetarget.report.preamble</code></td></tr>
171+
<tr class="b">
162172
<td><a href="#targetFile"><code>&lt;targetFile&gt;</code></a></td>
163173
<td><code>File</code></td>
164174
<td><code>-</code></td>
165175
<td>Specify the path to the target file to update, if not given the current project settings will be used to find a suitable file<br /><strong>User Property</strong>: <code>target</code></td></tr>
166176
<tr class="a">
177+
<td><a href="#updateEmptyVersion"><code>&lt;updateEmptyVersion&gt;</code></a></td>
178+
<td><code>boolean</code></td>
179+
<td><code>-</code></td>
180+
<td>If enabled, missing or empty versions are updated to the most recent found in the repository to guarantee a stable build<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>tycho.updatetarget.updateEmptyVersion</code></td></tr>
181+
<tr class="b">
167182
<td><a href="#updateSiteDiscovery"><code>&lt;updateSiteDiscovery&gt;</code></a></td>
168183
<td><code>List&lt;String&gt;</code></td>
169184
<td><code>-</code></td>
@@ -224,13 +239,34 @@ <h3>&lt;project&gt;</h3>
224239
<ul>
225240
<li><strong>Type</strong>: <code>org.apache.maven.project.MavenProject</code></li>
226241
<li><strong>Required</strong>: <code>No</code></li>
227-
<li><strong>User Property</strong>: <code>project</code></li></ul><hr /></section><a id="targetFile"></a><section><a id="a.3CtargetFile.3E"></a>
242+
<li><strong>User Property</strong>: <code>project</code></li></ul><hr /></section><a id="reportFileName"></a><section><a id="a.3CreportFileName.3E"></a>
243+
<h3>&lt;reportFileName&gt;</h3>
244+
<div>No description.</div>
245+
<ul>
246+
<li><strong>Type</strong>: <code>java.io.File</code></li>
247+
<li><strong>Required</strong>: <code>No</code></li>
248+
<li><strong>User Property</strong>: <code>tycho.updatetarget.report</code></li>
249+
<li><strong>Default</strong>: <code>${project.build.directory}/targetUpdates.md</code></li></ul><hr /></section><a id="reportPreamble"></a><section><a id="a.3CreportPreamble.3E"></a>
250+
<h3>&lt;reportPreamble&gt;</h3>
251+
<div>No description.</div>
252+
<ul>
253+
<li><strong>Type</strong>: <code>java.lang.String</code></li>
254+
<li><strong>Required</strong>: <code>No</code></li>
255+
<li><strong>User Property</strong>: <code>tycho.updatetarget.report.preamble</code></li>
256+
<li><strong>Default</strong>: <code>Please review the changes and merge if appropriate, or cherry pick individual updates.</code></li></ul><hr /></section><a id="targetFile"></a><section><a id="a.3CtargetFile.3E"></a>
228257
<h3>&lt;targetFile&gt;</h3>
229258
<div>Specify the path to the target file to update, if not given the current project settings will be used to find a suitable file</div>
230259
<ul>
231260
<li><strong>Type</strong>: <code>java.io.File</code></li>
232261
<li><strong>Required</strong>: <code>No</code></li>
233-
<li><strong>User Property</strong>: <code>target</code></li></ul><hr /></section><a id="updateSiteDiscovery"></a><section><a id="a.3CupdateSiteDiscovery.3E"></a>
262+
<li><strong>User Property</strong>: <code>target</code></li></ul><hr /></section><a id="updateEmptyVersion"></a><section><a id="a.3CupdateEmptyVersion.3E"></a>
263+
<h3>&lt;updateEmptyVersion&gt;</h3>
264+
<div>If enabled, missing or empty versions are updated to the most recent found in the repository to guarantee a stable build</div>
265+
<ul>
266+
<li><strong>Type</strong>: <code>boolean</code></li>
267+
<li><strong>Required</strong>: <code>No</code></li>
268+
<li><strong>User Property</strong>: <code>tycho.updatetarget.updateEmptyVersion</code></li>
269+
<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a id="updateSiteDiscovery"></a><section><a id="a.3CupdateSiteDiscovery.3E"></a>
234270
<h3>&lt;updateSiteDiscovery&gt;</h3>
235271
<div>A list of update site discovery strategies, the following is currently supported:
236272
<ul>

0 commit comments

Comments
 (0)