This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/iceberg-rust.git
The following commit(s) were added to refs/heads/gh-pages by this push:
new 677a82e deploy: 18f63fe9d5d4f0aa1db8dea1b4f591fadb7757d4
677a82e is described below
commit 677a82eb05c03f72b0f32efa5c99bfdfc20bb465
Author: Fokko <[email protected]>
AuthorDate: Fri Jan 12 21:39:24 2024 +0000
deploy: 18f63fe9d5d4f0aa1db8dea1b4f591fadb7757d4
---
CONTRIBUTING.html | 8 +++++++-
print.html | 8 +++++++-
searchindex.js | 2 +-
searchindex.json | 2 +-
4 files changed, 16 insertions(+), 4 deletions(-)
diff --git a/CONTRIBUTING.html b/CONTRIBUTING.html
index 80e930a..1df1291 100644
--- a/CONTRIBUTING.html
+++ b/CONTRIBUTING.html
@@ -256,6 +256,7 @@ refactor: Polish the implementation of read parquet
<p>The fastest way is:</p>
<p><a
href="https://codespaces.new/apache/iceberg-rust?quickstart=1&machine=standardLinux32gb";><img
src="https://github.com/codespaces/badge.svg"; alt="Open in GitHub Codespaces"
/></a></p>
<h3 id="bring-your-own-toolbox"><a class="header"
href="#bring-your-own-toolbox">Bring your own toolbox</a></h3>
+<h4 id="install-rust"><a class="header" href="#install-rust">Install
rust</a></h4>
<p>iceberg-rust is primarily a Rust project. To build iceberg-rust, you will
need to set up Rust development first. We highly recommend using <a
href="https://rustup.rs/";>rustup</a> for the setup process.</p>
<p>For Linux or MacOS, use the following command:</p>
<pre><code class="language-shell">curl --proto '=https' --tlsv1.2 -sSf
https://sh.rustup.rs | sh
@@ -265,11 +266,16 @@ refactor: Polish the implementation of read parquet
<pre><code class="language-shell">$ cargo version
cargo 1.69.0 (6e9a83356 2023-04-12)
</code></pre>
+<h4 id="install-docker"><a class="header" href="#install-docker">Install
docker</a></h4>
+<p>Currently, iceberg-rust uses docker to set up environment for integration
tests.</p>
+<p>You can learn how to install docker from <a
href="https://docs.docker.com/get-docker/";>here</a>.</p>
+<p>For macos users, you can install <a
href="https://orbstack.dev/";>OrbStack</a> as a docker alternative.</p>
<h2 id="build"><a class="header" href="#build">Build</a></h2>
<ul>
<li>To compile the project: <code>make build</code></li>
<li>To check code styles: <code>make check</code></li>
-<li>To run tests: <code>make test</code></li>
+<li>To run unit tests only: <code>make unit-test</code></li>
+<li>To run all tests: <code>make test</code></li>
</ul>
<h2 id="code-of-conduct"><a class="header" href="#code-of-conduct">Code of
Conduct</a></h2>
<p>We expect all community members to follow our <a
href="https://www.apache.org/foundation/policies/conduct.html";>Code of
Conduct</a>.</p>
diff --git a/print.html b/print.html
index c3dd16f..9b292e4 100644
--- a/print.html
+++ b/print.html
@@ -299,6 +299,7 @@ refactor: Polish the implementation of read parquet
<p>The fastest way is:</p>
<p><a
href="https://codespaces.new/apache/iceberg-rust?quickstart=1&machine=standardLinux32gb";><img
src="https://github.com/codespaces/badge.svg"; alt="Open in GitHub Codespaces"
/></a></p>
<h3 id="bring-your-own-toolbox"><a class="header"
href="#bring-your-own-toolbox">Bring your own toolbox</a></h3>
+<h4 id="install-rust"><a class="header" href="#install-rust">Install
rust</a></h4>
<p>iceberg-rust is primarily a Rust project. To build iceberg-rust, you will
need to set up Rust development first. We highly recommend using <a
href="https://rustup.rs/";>rustup</a> for the setup process.</p>
<p>For Linux or MacOS, use the following command:</p>
<pre><code class="language-shell">curl --proto '=https' --tlsv1.2 -sSf
https://sh.rustup.rs | sh
@@ -308,11 +309,16 @@ refactor: Polish the implementation of read parquet
<pre><code class="language-shell">$ cargo version
cargo 1.69.0 (6e9a83356 2023-04-12)
</code></pre>
+<h4 id="install-docker"><a class="header" href="#install-docker">Install
docker</a></h4>
+<p>Currently, iceberg-rust uses docker to set up environment for integration
tests.</p>
+<p>You can learn how to install docker from <a
href="https://docs.docker.com/get-docker/";>here</a>.</p>
+<p>For macos users, you can install <a
href="https://orbstack.dev/";>OrbStack</a> as a docker alternative.</p>
<h2 id="build"><a class="header" href="#build">Build</a></h2>
<ul>
<li>To compile the project: <code>make build</code></li>
<li>To check code styles: <code>make check</code></li>
-<li>To run tests: <code>make test</code></li>
+<li>To run unit tests only: <code>make unit-test</code></li>
+<li>To run all tests: <code>make test</code></li>
</ul>
<h2 id="code-of-conduct"><a class="header" href="#code-of-conduct">Code of
Conduct</a></h2>
<p>We expect all community members to follow our <a
href="https://www.apache.org/foundation/policies/conduct.html";>Code of
Conduct</a>.</p>
diff --git a/searchindex.js b/searchindex.js
index 3f86e47..07364ac 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Object.assign(window.search,
{"doc_urls":["introduction.html#iceberg-rust","install.html#install","CONTRIBUTING.html#contributing","CONTRIBUTING.html#your-first-contribution","CONTRIBUTING.html#workflow","CONTRIBUTING.html#git-branches","CONTRIBUTING.html#github-pull-requests","CONTRIBUTING.html#ci","CONTRIBUTING.html#setup","CONTRIBUTING.html#using-a-dev-container-environment","CONTRIBUTING.html#bring-your-own-toolbox","CONTRIBUTING.html#build","CONTRIBUTING.html#code-of-conduct"],"inde
[...]
\ No newline at end of file
+Object.assign(window.search,
{"doc_urls":["introduction.html#iceberg-rust","install.html#install","CONTRIBUTING.html#contributing","CONTRIBUTING.html#your-first-contribution","CONTRIBUTING.html#workflow","CONTRIBUTING.html#git-branches","CONTRIBUTING.html#github-pull-requests","CONTRIBUTING.html#ci","CONTRIBUTING.html#setup","CONTRIBUTING.html#using-a-dev-container-environment","CONTRIBUTING.html#bring-your-own-toolbox","CONTRIBUTING.html#build","CONTRIBUTING.html#code-of-conduct"],"inde
[...]
\ No newline at end of file
diff --git a/searchindex.json b/searchindex.json
index db0afa5..dc93216 100644
--- a/searchindex.json
+++ b/searchindex.json
@@ -1 +1 @@
-{"doc_urls":["introduction.html#iceberg-rust","install.html#install","CONTRIBUTING.html#contributing","CONTRIBUTING.html#your-first-contribution","CONTRIBUTING.html#workflow","CONTRIBUTING.html#git-branches","CONTRIBUTING.html#github-pull-requests","CONTRIBUTING.html#ci","CONTRIBUTING.html#setup","CONTRIBUTING.html#using-a-dev-container-environment","CONTRIBUTING.html#bring-your-own-toolbox","CONTRIBUTING.html#build","CONTRIBUTING.html#code-of-conduct"],"index":{"documentStore":{"docInfo
[...]
\ No newline at end of file
+{"doc_urls":["introduction.html#iceberg-rust","install.html#install","CONTRIBUTING.html#contributing","CONTRIBUTING.html#your-first-contribution","CONTRIBUTING.html#workflow","CONTRIBUTING.html#git-branches","CONTRIBUTING.html#github-pull-requests","CONTRIBUTING.html#ci","CONTRIBUTING.html#setup","CONTRIBUTING.html#using-a-dev-container-environment","CONTRIBUTING.html#bring-your-own-toolbox","CONTRIBUTING.html#build","CONTRIBUTING.html#code-of-conduct"],"index":{"documentStore":{"docInfo
[...]
\ No newline at end of file
![https://github.com/codespaces/badge.svg"](https://github.com/codespaces/badge.svg"){kind=link}