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 3f1c043 git sha 5305b5b43687ae34a14986db2dd3a0fd43a9601d
3f1c043 is described below
commit 3f1c043a9e04538981b6cfd865e70e423ce073c9
Author: Allen Wittenauer <[email protected]>
AuthorDate: Mon Nov 2 10:25:27 2020 -0800
git sha 5305b5b43687ae34a14986db2dd3a0fd43a9601d
---
.../in-progress/precommit/docker/index.html | 6 +++
.../travisci => github-status-recovery}/index.html | 46 ++++++++++++++--------
.../precommit/robots/travisci/index.html | 6 ++-
.../0.13.0/CHANGELOG.0.13.0/index.html | 8 ++++
.../0.13.0/RELEASENOTES.0.13.0/index.html | 19 +++++++++
5 files changed, 68 insertions(+), 17 deletions(-)
diff --git a/documentation/in-progress/precommit/docker/index.html
b/documentation/in-progress/precommit/docker/index.html
index 47dc445..31165a7 100644
--- a/documentation/in-progress/precommit/docker/index.html
+++ b/documentation/in-progress/precommit/docker/index.html
@@ -137,6 +137,7 @@
<li><a href="#container-directory">Container Directory</a></li>
</ul>
</li>
+ <li><a href="#buildkit">BuildKit</a></li>
<li><a href="#resource-controls">Resource Controls</a></li>
<li><a href="#privileged-mode">Privileged Mode</a></li>
<li><a href="#docker-in-docker">Docker in Docker</a></li>
@@ -192,6 +193,11 @@
not provided by other flags in system (such as <code>--basedir</code> or
<code>--patch-dir</code>). If that directory conflicts with some other<br />
need, then the <code>--docker-work-dir</code> option may be provided to set a
different path.</p>
+<h1 id="buildkit">BuildKit</h1>
+
+<p>By default, precommit will enable <a
href="https://docs.docker.com/develop/develop-images/build_enhancements/";>Docker
BuildKit</a><br />
+unless told otherwise with <code>--docker-buildkit=false</code> or if the CI
system has known limitations.</p>
+
<h1 id="resource-controls">Resource Controls</h1>
<p>Docker's <code>--memory</code> flag is supported via the
<code>--dockermemlimit</code> option. This enables the container's memory size
to be limited. This may be important to set to prevent things like broken unit
tests bringing down the entire build server. See <a
href="https://docs.docker.com/engine/admin/resource_constraints/";>the Docker
documentation</a> for more details. Apache Yetus also sets the
<code>--oom-score-adj</code> to 500 in order to offer itself as the first proce
[...]
diff --git a/documentation/in-progress/precommit/robots/travisci/index.html
b/documentation/in-progress/precommit/github-status-recovery/index.html
similarity index 75%
copy from documentation/in-progress/precommit/robots/travisci/index.html
copy to documentation/in-progress/precommit/github-status-recovery/index.html
index c5d6b84..7f38849 100644
--- a/documentation/in-progress/precommit/robots/travisci/index.html
+++ b/documentation/in-progress/precommit/github-status-recovery/index.html
@@ -25,13 +25,13 @@
<meta name="description" content="">
<meta name="author" content="">
- <link href="../../../../../assets/css/bootstrap.css" rel="stylesheet">
- <link href="../../../../../assets/css/bootstrap-theme.css"
rel="stylesheet">
- <link href="../../../../../assets/css/font-awesome.css"
rel="stylesheet">
+ <link href="../../../../assets/css/bootstrap.css" rel="stylesheet">
+ <link href="../../../../assets/css/bootstrap-theme.css"
rel="stylesheet">
+ <link href="../../../../assets/css/font-awesome.css" rel="stylesheet">
<!-- JS -->
- <script type="text/javascript"
src="../../../../../assets/js/jquery-2.1.4.min.js"></script>
- <script type="text/javascript"
src="../../../../../assets/js/bootstrap.js"></script>
+ <script type="text/javascript"
src="../../../../assets/js/jquery-2.1.4.min.js"></script>
+ <script type="text/javascript"
src="../../../../assets/js/bootstrap.js"></script>
</head>
<body>
@@ -45,7 +45,7 @@
<span class="icon-bar"></span>
</button>
<a class="img-responsive pull-left" href="/">
- <img style="max-height: 40px; margin-top: 5px; margin-bottom:
5px;" src="../../../../../assets/img/yetus_logo.png" alt="Apache Yetus logo" />
+ <img style="max-height: 40px; margin-top: 5px; margin-bottom:
5px;" src="../../../../assets/img/yetus_logo.png" alt="Apache Yetus logo" />
</a>
</div>
<div class="navbar-collapse collapse">
@@ -121,23 +121,37 @@
under the License.
-->
-<h1 id="robots-travis-ci">Robots: Travis CI</h1>
+<h1 id="github-status-recovery">GitHub Status Recovery</h1>
-<p>TRIGGER: ${TRAVIS}=true</p>
+<!-- MarkdownTOC levels="1,2,3" autolink="true" indent=" " bullets="*"
bracket="round" -->
-<p>Travis CI support will update the local checked out source repository to
include references to all branches and tags</p>
+<ul>
+ <li><a href="#problem-statement">Problem Statement</a></li>
+ <li><a href="#usage">Usage</a></li>
+ <li><a href="#disabling-annotations">Disabling Annotations</a></li>
+</ul>
-<p>If <code>${ARTIFACTS_PATH}</code> is configured, then
<code>--patch-dir</code> is set to the first listed directory path. However,
links to the location logs must still be configured manually.</p>
+<!-- /MarkdownTOC -->
-<p>Personalities will override the auto-detected Github repository
information. It may be necessary to manually configure it in your
<code>.travis.yml</code> file.</p>
+<h1 id="problem-statement">Problem Statement</h1>
-<p>As of this writing, it is not possible to make the Travis CI build
environment use the Apache Yetus pre-built docker images without using
<code>docker run</code> in the before_install phase. Therefore, using the
image is the same as described in the <a
href="../../../../../yetus-docker-image">Apache Yetus Docker Hub Images</a>
page.</p>
+<p>For CI systems that use GitHub outside of GitHub Actions, they may make
available a GitHub Checks token.<br />
+Unfortunately, as of this writing (2020-10-30), GitHub sets the expiry of such
a token to 1 hour.<br />
+For some users of Apache Yetus, their precommit job may take longer than one
hour. In order to workaround<br />
+this limitation, the <code>github-status-recovery</code> program may be
used.</p>
-<p>See also:</p>
+<h1 id="usage">Usage</h1>
-<ul>
- <li>Apache Yetus' source tree <a
href="https://github.com/apache/yetus/blob/main/.travis.yml";>.travis.yml</a>
for some tips and tricks.</li>
-</ul>
+<p>The usage is relatively simple:</p>
+
+<div class="highlight"><pre class="highlight shell"><code><span class="nv">$
</span>github-status-recovery <span class="nt">--patch-dir</span><span
class="o">=</span><pre-existing patch directory> <span
class="nt">--github-token</span><span class="o">=</span><token>
+</code></pre></div>
+<p>If the previous run of <code>test-patch</code> failed to write the status,
<code>github-status-recovery</code> will<br />
+re-process the saved JSON files as well as write GitHub Checks Annotations if
they exist.</p>
+
+<h1 id="disabling-annotations">Disabling Annotations</h1>
+
+<p>If for some reason you do not wish annotations to be written, they may be
disabled with <code>--github-annotations=false</code>.</p>
</div>
diff --git a/documentation/in-progress/precommit/robots/travisci/index.html
b/documentation/in-progress/precommit/robots/travisci/index.html
index c5d6b84..cdc5ed2 100644
--- a/documentation/in-progress/precommit/robots/travisci/index.html
+++ b/documentation/in-progress/precommit/robots/travisci/index.html
@@ -131,8 +131,12 @@
<p>Personalities will override the auto-detected Github repository
information. It may be necessary to manually configure it in your
<code>.travis.yml</code> file.</p>
-<p>As of this writing, it is not possible to make the Travis CI build
environment use the Apache Yetus pre-built docker images without using
<code>docker run</code> in the before_install phase. Therefore, using the
image is the same as described in the <a
href="../../../../../yetus-docker-image">Apache Yetus Docker Hub Images</a>
page.</p>
+<p>As of this writing, it is not possible to make the Travis CI build
environment use the Apache Yetus pre-built docker<br />
+images without using <code>docker run</code> in the before_install phase.
Therefore, using the image is the same as described<br />
+in the <a href="../../../../../yetus-docker-image">Apache Yetus Docker Hub
Images</a> page.</p>
+<div class="highlight"><pre class="highlight plaintext"><code>NOTE: As of this
writing (2020-10-31), Travis CI does not support Docker BuildKit. It is
disabled by default.
+</code></pre></div>
<p>See also:</p>
<ul>
diff --git a/downloads/releasenotes/0.13.0/CHANGELOG.0.13.0/index.html
b/downloads/releasenotes/0.13.0/CHANGELOG.0.13.0/index.html
index 12b617d..5cc1060 100644
--- a/downloads/releasenotes/0.13.0/CHANGELOG.0.13.0/index.html
+++ b/downloads/releasenotes/0.13.0/CHANGELOG.0.13.0/index.html
@@ -307,6 +307,14 @@
<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-1054";>YETUS-1054</a></td>
+ <td style="text-align: left">Support buildkit</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>
diff --git a/downloads/releasenotes/0.13.0/RELEASENOTES.0.13.0/index.html
b/downloads/releasenotes/0.13.0/RELEASENOTES.0.13.0/index.html
index 96947bb..45e25a0 100644
--- a/downloads/releasenotes/0.13.0/RELEASENOTES.0.13.0/index.html
+++ b/downloads/releasenotes/0.13.0/RELEASENOTES.0.13.0/index.html
@@ -617,6 +617,25 @@ With GitHub Checks Annotations being the preferred way on
GitHub for CI systems
<!-- markdown -->
<p>The new <code>github-status-recovery</code> program is a way to feed GitHub
results from an already executed precommit run. It requires a GitHub App token
to populate the GitHub Checks and GitHub Statuses data.</p>
+<hr />
+
+<ul>
+ <li>
+ <table class="table table-bordered table-striped">
+ <tbody>
+ <tr>
+ <td><a
href="https://issues.apache.org/jira/browse/YETUS-1054";>YETUS-1054</a></td>
+ <td><em>Major</em></td>
+ <td><strong>Support buildkit</strong></td>
+ </tr>
+ </tbody>
+ </table>
+ </li>
+</ul>
+
+<!-- markdown -->
+<p>precommit now defaults to using Docker BuildKit (with the notable exception
of Travis CI). To disable, use <code>--docker-buildkit=false</code>.</p>
+
</div>
