This is an automated email from the ASF dual-hosted git repository.
aw pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/yetus.git
The following commit(s) were added to refs/heads/asf-site by this push:
new ac4eaac git sha 5e346eee7da9a71caaaaba0451239c7c23b541b4
ac4eaac is described below
commit ac4eaac7b40b9a7c2cc5fc7643427a60247945b0
Author: Allen Wittenauer <[email protected]>
AuthorDate: Sun Oct 18 22:42:48 2020 -0700
git sha 5e346eee7da9a71caaaaba0451239c7c23b541b4
---
documentation/in-progress/CHANGELOG | 58 ++++++++--
documentation/in-progress/RELEASENOTES | 120 +++++++++++++++++++++
.../in-progress/precommit/apidocs/core/index.html | 88 +++++++--------
.../in-progress/precommit/bugsystems/index.html | 38 +++++--
.../precommit/plugins/{github => buf}/index.html | 31 +++---
.../precommit/plugins/github/index.html | 4 +
.../precommit/robots/githubactions/index.html | 16 +++
.../precommit/robots/jenkins/index.html | 22 ++++
.../in-progress/precommit/usage-intro/index.html | 20 ++++
project-reports.html | 4 +-
10 files changed, 321 insertions(+), 80 deletions(-)
diff --git a/documentation/in-progress/CHANGELOG
b/documentation/in-progress/CHANGELOG
index 0f0fe7d..7e893f8 100644
--- a/documentation/in-progress/CHANGELOG
+++ b/documentation/in-progress/CHANGELOG
@@ -18,7 +18,7 @@
-->
<h1 id="apache-yetus-changelog">Apache Yetus Changelog</h1>
-<h2 id="release-0130-snapshot---2020-10-12">Release 0.13.0-SNAPSHOT -
2020-10-12</h2>
+<h2 id="release-0130-snapshot---2020-10-19">Release 0.13.0-SNAPSHOT -
2020-10-19</h2>
<h3 id="important-issues">IMPORTANT ISSUES:</h3>
@@ -91,6 +91,14 @@
<td style="text-align: left">Allen Wittenauer</td>
</tr>
<tr>
+ <td style="text-align: left"><a
href="https://issues.apache.org/jira/browse/YETUS-1012";>YETUS-1012</a></td>
+ <td style="text-align: left">Major overhaul of precommit
documentation</td>
+ <td style="text-align: left">Major</td>
+ <td style="text-align: left">website and documentation</td>
+ <td style="text-align: left">Allen Wittenauer</td>
+ <td style="text-align: left">Allen Wittenauer</td>
+ </tr>
+ <tr>
<td style="text-align: left"><a
href="https://issues.apache.org/jira/browse/YETUS-1017";>YETUS-1017</a></td>
<td style="text-align: left">Rework post-processing comparison to
de-duplicate code</td>
<td style="text-align: left">Major</td>
@@ -106,6 +114,22 @@
<td style="text-align: left">Allen Wittenauer</td>
<td style="text-align: left">Allen Wittenauer</td>
</tr>
+ <tr>
+ <td style="text-align: left"><a
href="https://issues.apache.org/jira/browse/YETUS-992";>YETUS-992</a></td>
+ <td style="text-align: left">Create and publish a github action</td>
+ <td style="text-align: left">Major</td>
+ <td style="text-align: left">Precommit</td>
+ <td style="text-align: left">Allen Wittenauer</td>
+ <td style="text-align: left">Allen Wittenauer</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a
href="https://issues.apache.org/jira/browse/YETUS-1028";>YETUS-1028</a></td>
+ <td style="text-align: left">Various missing github annotations</td>
+ <td style="text-align: left">Major</td>
+ <td style="text-align: left">Precommit</td>
+ <td style="text-align: left">Allen Wittenauer</td>
+ <td style="text-align: left">Allen Wittenauer</td>
+ </tr>
</tbody>
</table>
@@ -285,14 +309,6 @@
<td style="text-align: left">Allen Wittenauer</td>
</tr>
<tr>
- <td style="text-align: left"><a
href="https://issues.apache.org/jira/browse/YETUS-1012";>YETUS-1012</a></td>
- <td style="text-align: left">Major overhaul of precommit
documentation</td>
- <td style="text-align: left">Major</td>
- <td style="text-align: left">website and documentation</td>
- <td style="text-align: left">Allen Wittenauer</td>
- <td style="text-align: left">Allen Wittenauer</td>
- </tr>
- <tr>
<td style="text-align: left"><a
href="https://issues.apache.org/jira/browse/YETUS-1016";>YETUS-1016</a></td>
<td style="text-align: left">Various test-patch performance
improvements</td>
<td style="text-align: left">Minor</td>
@@ -421,6 +437,30 @@
<td style="text-align: left">Allen Wittenauer</td>
<td style="text-align: left">Allen Wittenauer</td>
</tr>
+ <tr>
+ <td style="text-align: left"><a
href="https://issues.apache.org/jira/browse/YETUS-1024";>YETUS-1024</a></td>
+ <td style="text-align: left">github actions docs point to wrong repo,
missing secrets</td>
+ <td style="text-align: left">Trivial</td>
+ <td style="text-align: left">website and documentation</td>
+ <td style="text-align: left">Allen Wittenauer</td>
+ <td style="text-align: left">Allen Wittenauer</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a
href="https://issues.apache.org/jira/browse/YETUS-1025";>YETUS-1025</a></td>
+ <td style="text-align: left">bufcompat doesn't get linecomments</td>
+ <td style="text-align: left">Major</td>
+ <td style="text-align: left">Precommit</td>
+ <td style="text-align: left">Allen Wittenauer</td>
+ <td style="text-align: left">Allen Wittenauer</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><a
href="https://issues.apache.org/jira/browse/YETUS-1027";>YETUS-1027</a></td>
+ <td style="text-align: left">checkmake output is incorrect</td>
+ <td style="text-align: left">Blocker</td>
+ <td style="text-align: left">Precommit</td>
+ <td style="text-align: left">Allen Wittenauer</td>
+ <td style="text-align: left">Allen Wittenauer</td>
+ </tr>
</tbody>
</table>
diff --git a/documentation/in-progress/RELEASENOTES
b/documentation/in-progress/RELEASENOTES
index 38cb6ba..b33ffd9 100644
--- a/documentation/in-progress/RELEASENOTES
+++ b/documentation/in-progress/RELEASENOTES
@@ -121,6 +121,10 @@
</ul>
<!-- markdown -->
+<p>Users:</p>
+
+<p>The log files for tests have been popped up into the voting table for many
of the generated reports.</p>
+
<p>Developers:</p>
<p>This is a breaking change. It reworks how tests should be registering the
logfiles that they present to users and how bugsystem reporting engines should
retrieve the filenames for those logfiles:</p>
@@ -207,6 +211,25 @@ With GitHub Checks Annotations being the preferred way on
GitHub for CI systems
<table class="table table-bordered table-striped">
<tbody>
<tr>
+ <td><a
href="https://issues.apache.org/jira/browse/YETUS-1012";>YETUS-1012</a></td>
+ <td><em>Major</em></td>
+ <td><strong>Major overhaul of precommit documentation</strong></td>
+ </tr>
+ </tbody>
+ </table>
+ </li>
+</ul>
+
+<!-- markdown -->
+<p>The <a
href="http://yetus.apache.org/documentation/in-progress/precommit/";>precommit
documentation on the ASF site</a> has been revamped! It now features greatly
expanded information, more parameters are documented, more commands are
documented, and even separate pages per plug-in!</p>
+
+<hr />
+
+<ul>
+ <li>
+ <table class="table table-bordered table-striped">
+ <tbody>
+ <tr>
<td><a
href="https://issues.apache.org/jira/browse/YETUS-1017";>YETUS-1017</a></td>
<td><em>Major</em></td>
<td><strong>Rework post-processing comparison to de-duplicate
code</strong></td>
@@ -246,3 +269,100 @@ Users:</p>
<p>It also takes two different parameters:
<code>--blanks-eol-ignore-file=<file></code> and
<code>--blanks-tabs-ignore-file=<file></code> . These files contain
regular expressions of files to ignore for their various targets, similar to
the –excludes file option. By default, Apache Yetus will automatically use
<code>.yetus/blanks-eol.txt</code> and <code>.yetus/blanks-tabs.txt</code> if
they exist.</p>
+<hr />
+
+<ul>
+ <li>
+ <table class="table table-bordered table-striped">
+ <tbody>
+ <tr>
+ <td><a
href="https://issues.apache.org/jira/browse/YETUS-1021";>YETUS-1021</a></td>
+ <td><em>Major</em></td>
+ <td><strong>Lots of minor documentation updates
post-overhaul</strong></td>
+ </tr>
+ </tbody>
+ </table>
+ </li>
+</ul>
+
+<!-- markdown -->
+<p>Developers:</p>
+
+<p>A new website link checker has been added to the CI process to verify that
links are actually valid.</p>
+
+<hr />
+
+<ul>
+ <li>
+ <table class="table table-bordered table-striped">
+ <tbody>
+ <tr>
+ <td><a
href="https://issues.apache.org/jira/browse/YETUS-1022";>YETUS-1022</a></td>
+ <td><em>Major</em></td>
+ <td><strong>Get commit sha from github PR json</strong></td>
+ </tr>
+ </tbody>
+ </table>
+ </li>
+</ul>
+
+<!-- markdown -->
+<p>Git SHAs should now be more consistent on repositories hosted on GitHub,
especially when running on Jenkins.</p>
+
+<hr />
+
+<ul>
+ <li>
+ <table class="table table-bordered table-striped">
+ <tbody>
+ <tr>
+ <td><a
href="https://issues.apache.org/jira/browse/YETUS-1027";>YETUS-1027</a></td>
+ <td><em>Blocker</em></td>
+ <td><strong>checkmake output is incorrect</strong></td>
+ </tr>
+ </tbody>
+ </table>
+ </li>
+</ul>
+
+<!-- markdown -->
+<p>Prior to this fix, <code>checkmake</code> may have returned irrelevant
results for a given change.</p>
+
+<hr />
+
+<ul>
+ <li>
+ <table class="table table-bordered table-striped">
+ <tbody>
+ <tr>
+ <td><a
href="https://issues.apache.org/jira/browse/YETUS-992";>YETUS-992</a></td>
+ <td><em>Major</em></td>
+ <td><strong>Create and publish a github action</strong></td>
+ </tr>
+ </tbody>
+ </table>
+ </li>
+</ul>
+
+<!-- markdown -->
+<p>With this release, Apache Yetus' <code>test-patch</code> facility is now
available as a Github Action! Please see the documentation for more details.</p>
+
+<hr />
+
+<ul>
+ <li>
+ <table class="table table-bordered table-striped">
+ <tbody>
+ <tr>
+ <td><a
href="https://issues.apache.org/jira/browse/YETUS-1028";>YETUS-1028</a></td>
+ <td><em>Major</em></td>
+ <td><strong>Various missing github annotations</strong></td>
+ </tr>
+ </tbody>
+ </table>
+ </li>
+</ul>
+
+<!-- markdown -->
+<p>Many outputs for plug-ins have been reworked to provide a consistent format
as well as compatibility with such features as GitHub Checks Annotations.
Additionally, most of the log files have been renamed to be prefixed with
<code>results</code> to make them more consistent between the various modes.</p>
+
diff --git a/documentation/in-progress/precommit/apidocs/core/index.html
b/documentation/in-progress/precommit/apidocs/core/index.html
index 8826309..10049b9 100644
--- a/documentation/in-progress/precommit/apidocs/core/index.html
+++ b/documentation/in-progress/precommit/apidocs/core/index.html
@@ -150,6 +150,7 @@
<li>Public/Stable/Not Replaceable
<ul>
<li><a href="#add_version_data">add_version_data</a></li>
+ <li><a href="#common_defaults">common_defaults</a></li>
<li><a href="#delete_parameter">delete_parameter</a></li>
<li><a href="#escape_html">escape_html</a></li>
<li><a href="#generate_stack">generate_stack</a></li>
@@ -162,7 +163,6 @@
<li><a
href="#yetus_find_deepest_directory">yetus_find_deepest_directory</a></li>
<li><a href="#yetus_run_and_redirect">yetus_run_and_redirect</a></li>
<li><a href="#yetus_get_ctime">yetus_get_ctime</a></li>
- <li><a href="#common_defaults">common_defaults</a></li>
</ul>
</li>
<li>Public/Evolving/Replaceable
@@ -1203,6 +1203,49 @@
</tbody>
</table>
+<h3 id="common_defaults"><code>common_defaults</code></h3>
+
+<ul>
+ <li>Synopsis</li>
+</ul>
+
+<div class="highlight"><pre class="highlight plaintext"><code>common_defaults
+</code></pre></div>
+<ul>
+ <li>Description</li>
+</ul>
+
+<p>Setup the default global variables</p>
+
+<ul>
+ <li>Returns</li>
+</ul>
+
+<p>Nothing</p>
+
+<table class="table table-bordered table-striped">
+ <thead>
+ <tr>
+ <th style="text-align: left">Classification</th>
+ <th style="text-align: left">Level</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td style="text-align: left">Audience</td>
+ <td style="text-align: left">Public</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">Stability</td>
+ <td style="text-align: left">Stable</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">Replaceable</td>
+ <td style="text-align: left">No</td>
+ </tr>
+ </tbody>
+</table>
+
<h3 id="delete_parameter"><code>delete_parameter</code></h3>
<ul>
@@ -1723,49 +1766,6 @@
</tbody>
</table>
-<h3 id="common_defaults"><code>common_defaults</code></h3>
-
-<ul>
- <li>Synopsis</li>
-</ul>
-
-<div class="highlight"><pre class="highlight plaintext"><code>common_defaults
-</code></pre></div>
-<ul>
- <li>Description</li>
-</ul>
-
-<p>Setup the default global variables</p>
-
-<ul>
- <li>Returns</li>
-</ul>
-
-<p>Nothing</p>
-
-<table class="table table-bordered table-striped">
- <thead>
- <tr>
- <th style="text-align: left">Classification</th>
- <th style="text-align: left">Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Audience</td>
- <td style="text-align: left">Public</td>
- </tr>
- <tr>
- <td style="text-align: left">Stability</td>
- <td style="text-align: left">Stable</td>
- </tr>
- <tr>
- <td style="text-align: left">Replaceable</td>
- <td style="text-align: left">No</td>
- </tr>
- </tbody>
-</table>
-
<h2 id="publicevolvingreplaceable">Public/Evolving/Replaceable</h2>
<h3 id="get_artifact_url"><code>get_artifact_url</code></h3>
diff --git a/documentation/in-progress/precommit/bugsystems/index.html
b/documentation/in-progress/precommit/bugsystems/index.html
index 834c110..1020e36 100644
--- a/documentation/in-progress/precommit/bugsystems/index.html
+++ b/documentation/in-progress/precommit/bugsystems/index.html
@@ -187,11 +187,25 @@
<h1 id="github-specific">GitHub Specific</h1>
-<p>GitHub supports the full range of functionality, including putting comments
on individual lines. Be aware, however, that <code>test-patch</code> will
(generally) require that GitHub PRs be fully squashed and rebased (i.e., a
single commit) in many circumstances.</p>
-
-<p>By default, the GitHub plug-in assumes that <a
href="https://github.com";>https://github.com</a> is the base URL for GitHub.
Enterprise users may override this with the <code>--github-base-url</code> for
the normal web user interface and <code>--github-api-url</code> for the API
URL. Personalities may use GITHUB_API_URL and GITHUB_BASE_URL.</p>
-
-<p>The specific repository on GitHub is defined with either
<code>--github-repo</code> on the command line or GITHUB_REPO in a personality.
It should take the form of "user/repo".</p>
+<p>GitHub supports a large range of functionality, mostly self-adjusting based
upon the<br />
+environment it is running in. Supported features include GitHub Enterprise,
private<br />
+repositories, GitHub Statuses, and GitHub Checks Annotations.</p>
+
+<p>Be aware, however, that <code>test-patch</code> will (generally) require<br
/>
+that GitHub PRs be fully squashed and rebased (i.e., a single commit) in
many<br />
+circumstances, especially renames followed by commits to those renamed files.
It will<br />
+try to fall back to 'diff' format if 'patch' format does not work, exiting<br
/>
+completely if both fail.</p>
+
+<p>By default, the GitHub plug-in assumes that <a
href="https://github.com";>https://github.com</a> is the base URL<br />
+for GitHub and <a href="https://api.github.com";>https://api.github.com</a> for
base of the GitHub API URL. Enterprise<br />
+users may override this with the <code>--github-base-url</code> for the normal
web user<br />
+interface and <code>--github-api-url</code> for the API URL. Personalities
may use<br />
+GITHUB_API_URL and GITHUB_BASE_URL.</p>
+
+<p>The specific repository on GitHub is defined with either
<code>--github-repo</code> on the<br />
+command line, GITHUB_REPO in a personality, or automatically determined by
various<br />
+robot support mechanisms. It should take the form of "user/repo".</p>
<p>GitHub pull requests may be directly processed on the command line in two
ways:</p>
@@ -205,14 +219,24 @@ Pull requests that are made off of a specific branch will
switch the test repo t
<h2 id="github-authentication">GitHub Authentication</h2>
-<p>In order to comment on issues or, depending upon the security setup of the
repo, authentication credentials. The GitHub plug-in supports authentication
via token or user name/passphrase.</p>
+<p>Some operations depend upon authentication credentials. The GitHub
plug-in<br />
+supports authentication via token or user name/passphrase. Authentication
is<br />
+required for controlling the API query rate, accessing private
repositories,<br />
+reading private pull requests, updating GitHub Statuses (requires<br />
+<code>repo:status</code> permissions), writing comments to PRs, and other
functionality.</p>
+
+<p>Some <a href="../robots">robots</a> have built-in support for providing
GitHub tokens. See<br />
+the appropriate documentation for your particular setup.</p>
<h3 id="github-token">GitHub Token</h3>
<p>The token is provided via the <code>--github-token</code> option.</p>
-<h3 id="github-usernamepassword-deprecated">GitHub Username/password
(Deprecated)</h3>
+<h3 id="github-usernamepassword">GitHub Username/password</h3>
+<div class="highlight"><pre class="highlight plaintext"><code>NOTE: GitHub is
deprecating this format. It is kept here for backward compatibility
+until such a time the format is completely removed from modern implementations.
+</code></pre></div>
<p>The user name is provided via the <code>--github-user</code> option or the
GITHUB_USER environment variable. The default value for GITHUB_USER is the
value of <code>--project</code> suffixed with QA. For example,<br />
<code>--project=yetus</code> will set <code>GITHUB_USER=yetusqa</code>.</p>
diff --git a/documentation/in-progress/precommit/plugins/github/index.html
b/documentation/in-progress/precommit/plugins/buf/index.html
similarity index 84%
copy from documentation/in-progress/precommit/plugins/github/index.html
copy to documentation/in-progress/precommit/plugins/buf/index.html
index 3ce9b60..d63c5d1 100644
--- a/documentation/in-progress/precommit/plugins/github/index.html
+++ b/documentation/in-progress/precommit/plugins/buf/index.html
@@ -123,15 +123,18 @@
<h1 id="name">Name</h1>
-<p>github</p>
+<p>buf<br />
+buflint<br />
+bufcompat</p>
<h1 id="category">Category</h1>
-<p>Bug System</p>
+<p>Test</p>
<h1 id="description">Description</h1>
-<p>Enables support for reading and writing back to <a
href="https://github.com/";>GitHub</a> and compatible systems such as GitHub
Enterprise. See also the <a href="../../bugsystems">Bugsystems</a>
documentation for more information.</p>
+<p><a href="https://github.com/bufbuild/buf";>buf</a> is a protobuf linter
(<code>buflint</code>) and backward compatibility checker
(<code>bufcompat</code>).<br />
+In order to use either <code>buflint</code> or <code>bufcompat</code>,
<code>buf</code> must also be enabled.</p>
<h1 id="environment-variables">Environment Variables</h1>
@@ -148,24 +151,16 @@
</thead>
<tbody>
<tr>
- <td style="text-align:
left"><code>--github-api-url=<url></code></td>
- <td style="text-align: left">REST API URL (for GitHub Enterprise)</td>
+ <td style="text-align: left"><code>--buf=<file></code></td>
+ <td style="text-align: left">path to <code>buf</code> executable if it
is not on the path</td>
</tr>
<tr>
- <td style="text-align:
left"><code>--github-base-url=<url></code></td>
- <td style="text-align: left">Non-REST API URL (for GitHub
Enterprise)</td>
+ <td style="text-align: left"><code>--buf-basedir=<dir></code></td>
+ <td style="text-align: left">set the starting dir to run buf</td>
</tr>
<tr>
- <td style="text-align:
left"><code>--github-password=<pw></code></td>
- <td style="text-align: left">Password or OAuth 2.0 token to use for
authentication</td>
- </tr>
- <tr>
- <td style="text-align: left"><code>--github-repo=<repo></code></td>
- <td style="text-align: left"><code>username/repository</code>
identifier</td>
- </tr>
- <tr>
- <td style="text-align: left"><code>--github-user=<user></code></td>
- <td style="text-align: left">Username to use for authentication</td>
+ <td style="text-align: left"><code>--buf-timeout=###u</code></td>
+ <td style="text-align: left">Set the buf timeout</td>
</tr>
</tbody>
</table>
@@ -176,7 +171,7 @@
<h1 id="developer-notes">Developer Notes</h1>
-<p>All of the command line settings may also be set via internal environment
variables. However care must be taken to not step on <a
href="../../robots">robots</a> that will also set some of these variables.</p>
+<p>None</p>
</div>
diff --git a/documentation/in-progress/precommit/plugins/github/index.html
b/documentation/in-progress/precommit/plugins/github/index.html
index 3ce9b60..73c5f08 100644
--- a/documentation/in-progress/precommit/plugins/github/index.html
+++ b/documentation/in-progress/precommit/plugins/github/index.html
@@ -167,6 +167,10 @@
<td style="text-align: left"><code>--github-user=<user></code></td>
<td style="text-align: left">Username to use for authentication</td>
</tr>
+ <tr>
+ <td style="text-align:
left"><code>--github-token=<token></code></td>
+ <td style="text-align: left">Token used to perform read and write
operations</td>
+ </tr>
</tbody>
</table>
diff --git
a/documentation/in-progress/precommit/robots/githubactions/index.html
b/documentation/in-progress/precommit/robots/githubactions/index.html
index 857e98a..1c5f60c 100644
--- a/documentation/in-progress/precommit/robots/githubactions/index.html
+++ b/documentation/in-progress/precommit/robots/githubactions/index.html
@@ -276,6 +276,12 @@ Options currently supported are:</p>
<td style="text-align: center"><code>.revive.toml</code></td>
<td style="text-align: center"><a href="../../plugins/revive">revive
plug-in</a></td>
</tr>
+ <tr>
+ <td style="text-align: center">testsfilter</td>
+ <td style="text-align: center">same as <code>--tests-filter</code></td>
+ <td style="text-align: center">''</td>
+ <td style="text-align: center"><a href="../../usage-intro">Usage
Introduction</a></td>
+ </tr>
</tbody>
</table>
@@ -308,6 +314,11 @@ Options currently supported are:</p>
<td style="text-align: center"><a href="../../plugins/htmlout">htmlout
plug-in</a></td>
</tr>
<tr>
+ <td style="text-align: center"><code>--ignore-unknown-options</code></td>
+ <td style="text-align: center">true</td>
+ <td style="text-align: center"><a href="../../usage-intro">Usage
Introduction</a></td>
+ </tr>
+ <tr>
<td style="text-align: center"><code>--junit-report-xml</code></td>
<td style="text-align: center">patchdir/junit-report.xml</td>
<td style="text-align: center"><a
href="../../plugins/junit-bugsystem">junit plug-in</a></td>
@@ -317,6 +328,11 @@ Options currently supported are:</p>
<td style="text-align: center">true</td>
<td style="text-align: center"><a href="../../plugins/pylint">pylint
plug-in</a></td>
</tr>
+ <tr>
+ <td style="text-align: center"><code>--report-unknown-options</code></td>
+ <td style="text-align: center">true</td>
+ <td style="text-align: center"><a href="../../usage-intro">Usage
Introduction</a></td>
+ </tr>
</tbody>
</table>
diff --git a/documentation/in-progress/precommit/robots/jenkins/index.html
b/documentation/in-progress/precommit/robots/jenkins/index.html
index 9ccdc44..6f192c2 100644
--- a/documentation/in-progress/precommit/robots/jenkins/index.html
+++ b/documentation/in-progress/precommit/robots/jenkins/index.html
@@ -173,6 +173,26 @@
<span class="o">}</span>
<span class="o">}</span>
</code></pre></div>
+<h2 id="github-token-support">GitHub Token Support</h2>
+
+<p>Using the Jenkins Credential system, one can provide a specific personal
access token<br />
+to use with GitHub. However, it is recommended that Jenkins be configured to
act as<br />
+a GitHub application as per the<br />
+<a
href="https://docs.cloudbees.com/docs/cloudbees-jenkins-platform/latest/github-app-auth";>Cloudbees
documentation</a><br />
+for the optimal <code>test-patch</code> experience. Configure up to the
"Configuring the GitHub Organization" and then, using the Jenkins credential
system, pass the GitHub App's token to <code>test-patch</code>. For example:</p>
+
+<div class="highlight"><pre class="highlight groovy"><code><span
class="o">...</span>
+ <span class="n">withCredentials</span><span class="o">([</span><span
class="n">usernamePassword</span><span class="o">(</span><span
class="nl">credentialsId:</span> <span class="s1">'github-app'</span><span
class="o">,</span>
+ <span class="nl">passwordVariable:</span> <span
class="s1">'GITHUB_TOKEN'</span><span class="o">,</span>
+ <span class="nl">usernameVariable:</span> <span
class="s1">'GITHUB_USER'</span><span class="o">)])</span> <span
class="o">{</span>
+<span class="o">...</span>
+
+ <span class="n">sh</span> <span class="s1">'''test-patch
--github-token="${GITHUB_TOKEN}" (other options)'''</span>
+<span class="o">...</span>
+</code></pre></div>
+<p>Doing so will enable in many circumstances a bit more functionality, such
as<br />
+GitHub Statuses.</p>
+
<p>See also:</p>
<ul>
@@ -181,6 +201,8 @@
<li><a
href="https://wiki.jenkins.io/display/JENKINS/GitHub+Branch+Source+Plugin";>GitHub
Branch Source Plugin</a></li>
<li><a
href="https://wiki.jenkins.io/display/JENKINS/GitHub+pull+request+builder+plugin";>GitHub
Pull Request Builder Plugin</a></li>
<li><code>https://{your local server}/env-vars.html/</code></li>
+ <li><a
href="https://cd.foundation/blog/2020/04/22/from-jenkins-github-app-authentication-support-released/";>From
Jenkins – GitHub App authentication support released</a></li>
+ <li><a
href="https://docs.cloudbees.com/docs/cloudbees-jenkins-platform/latest/github-app-auth";>Jenkins
- Using GitHub App authentication</a></li>
</ul>
</div>
diff --git a/documentation/in-progress/precommit/usage-intro/index.html
b/documentation/in-progress/precommit/usage-intro/index.html
index 8ee740c..8c82227 100644
--- a/documentation/in-progress/precommit/usage-intro/index.html
+++ b/documentation/in-progress/precommit/usage-intro/index.html
@@ -150,6 +150,7 @@
</ul>
</li>
<li><a href="#excluding-files">Excluding Files</a></li>
+ <li><a href="#warn-only-test-results">"Warn-only" Test Results</a></li>
<li><a href="#project-specific-capabilities">Project-specific
Capabilities</a>
<ul>
<li><a href="#direct-method">Direct Method</a></li>
@@ -159,6 +160,7 @@
<li><a href="#fork-bomb-protection">Fork Bomb Protection</a></li>
<li><a href="#multijdk">MultiJDK</a></li>
<li><a href="#docker">Docker</a></li>
+ <li><a href="#upgrading">Upgrading</a></li>
<li><a href="#in-closing">In Closing</a></li>
</ul>
@@ -460,6 +462,16 @@ may be overwritten by using the <code>--excludes</code>
flag:</p>
<div class="highlight"><pre class="highlight plaintext"><code>NOTE: for best
results, avoid using ^ and $ in your regular expressions. `test-patch` will
automatically
anchor the contents of that file.
</code></pre></div>
+<h1 id="warn-only-test-results">"Warn-only" Test Results</h1>
+
+<p>In some cases, test plug-ins may always generate fail results in ways that
cannot be avoided or are so<br />
+monumental to fix that you just want to keep track of the results without ever
failing the run. <code>test-patch</code><br />
+provides the <code>--tests-filter</code> option to do just that; print the
results but don't fail the job. For example:</p>
+
+<div class="highlight"><pre class="highlight shell"><code><span class="nv">$
</span>test-patch <span class="nt">--plugins</span><span class="o">=</span>all
<span class="nt">--tests-filter</span><span
class="o">=</span>checkstyle,javadoc <span class="o">(</span>other options<span
class="o">)</span>
+</code></pre></div>
+<p>… will always force the <code>checkstyle</code> and <code>javadoc</code>
tests to never vote -1.</p>
+
<h1 id="project-specific-capabilities">Project-specific Capabilities</h1>
<p>Due to the extensible nature of the system, <code>test-patch</code> allows
for projects to define project-specific rules which we call personalities.
(How to build those rules is covered elsewhere.) There are two ways to specify
which personality to use:</p>
@@ -504,6 +516,14 @@ anchor the contents of that file.
</code></pre></div>
<p>This command will do some preliminary setup and then re-execute itself
inside a Docker container. For more information on how to provide a custom
Dockerfile and other Docker-specific features, see the specific <a
href="../docker">precommit Docker support</a> page and the <a
href="../../../../yetus-docker-image">Apache Yetus Docker Hub Images</a> page
for more information on the convenience Docker images.</p>
+<h1 id="upgrading">Upgrading</h1>
+
+<p>Currently, Apache Yetus is still undergoing incompatible changes from time
to time. Despite that, in many cases<br />
+the upgrade process for <code>test-patch</code> and friends is usually just
verifying what flags are being passed. To help out,<br />
+there is an option to <code>--ignore-unknown-options</code> so that
<code>test-patch</code> does not error out if it is given flags it no<br />
+longer understands. It will print a list of those unknown options in the end
report. In situations where that is<br />
+also undesirable, the <code>--report-unknown-options</code> may also be set
simultaneously to remove the list from the report.</p>
+
<h1 id="in-closing">In Closing</h1>
<p><code>test-patch</code> has many other features and command line options
for the basic user. Many of these are self-explanatory. To see the list of
options, run <code>test-patch</code> without any options or with
<code>--help</code>.</p>
diff --git a/project-reports.html b/project-reports.html
index a11800d..9a59de3 100644
--- a/project-reports.html
+++ b/project-reports.html
@@ -1,5 +1,5 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
-<!-- Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-site-plugin:3.7.1:CategorySummaryDocumentRenderer
at 2020-10-12 -->
+<!-- Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-site-plugin:3.7.1:CategorySummaryDocumentRenderer
at 2020-10-19 -->
<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
@@ -24,7 +24,7 @@ Apache Yetus Project
</div>
<div id="breadcrumbs">
<div class="xleft">
- <span id="publishDate">Last Published: 2020-10-12</span>
+ <span id="publishDate">Last Published: 2020-10-19</span>
| <span id="projectVersion">Version: 0.13.0-SNAPSHOT</span>
</div>
<div class="xright"><a href="./" title="Apache Yetus Project">Apache
Yetus Project</a> </div>
