You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datafusion.apache.org by gi...@apache.org on 2026/09/14 15:27:23 UTC
(datafusion) branch asf-site updated: Publish built docs triggered by afaee3d4cece5f2d4784df2bd02c9b1a5402ab03

This is an automated email from the ASF dual-hosted git repository.

github-actions[bot] pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/datafusion.git


The following commit(s) were added to refs/heads/asf-site by this push:
     new 7417be8151 Publish built docs triggered by afaee3d4cece5f2d4784df2bd02c9b1a5402ab03
7417be8151 is described below

commit 7417be8151d5bcc181b811d3d1451291129c4962
Author: github-actions[bot] <gi...@users.noreply.github.com>
AuthorDate: Mon Sep 14 15:27:16 2026 +0000

    Publish built docs triggered by afaee3d4cece5f2d4784df2bd02c9b1a5402ab03
---
 _downloads/1e336e540124589d1e27210fa4f805f6/rust_lint.sh | 10 +++++++++-
 _sources/contributor-guide/testing.md.txt                |  8 +++++++-
 contributor-guide/testing.html                           |  7 ++++++-
 searchindex.js                                           |  2 +-
 4 files changed, 23 insertions(+), 4 deletions(-)

diff --git a/_downloads/1e336e540124589d1e27210fa4f805f6/rust_lint.sh b/_downloads/1e336e540124589d1e27210fa4f805f6/rust_lint.sh
index 73cab9c7f7..542ed18c6b 100644
--- a/_downloads/1e336e540124589d1e27210fa4f805f6/rust_lint.sh
+++ b/_downloads/1e336e540124589d1e27210fa4f805f6/rust_lint.sh
@@ -22,7 +22,9 @@
 #
 # Note: The installed checking tools (e.g., taplo) are not guaranteed to match
 # the CI versions for simplicity, there might be some minor differences. Check
-# `.github/workflows` for the CI versions.
+# `.github/workflows` for the CI versions. When this script installs a missing
+# tool that has a pinned version in `ci/scripts/utils/tool_versions.sh`, it
+# installs that pinned version. An already installed tool is used as is.
 #
 #
 #
@@ -84,10 +86,15 @@ while [[ $# -gt 0 ]]; do
 done
 
 SCRIPT_NAME="$(basename "${BASH_SOURCE[0]}")"
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+
+# Load the tool versions shared with CI (for example, LYCHEE_VERSION).
+source "${SCRIPT_DIR}/../ci/scripts/utils/tool_versions.sh"
 
 ensure_tool "taplo" "cargo install taplo-cli --locked"
 ensure_tool "hawkeye" "cargo install hawkeye --locked"
 ensure_tool "typos" "cargo install typos-cli --locked"
+ensure_tool "lychee" "cargo install lychee --locked --version ${LYCHEE_VERSION}"
 
 run_step() {
   local name="$1"
@@ -107,6 +114,7 @@ declare -a WRITE_STEPS=(
 
 declare -a READONLY_STEPS=(
   "ci/scripts/check_no_cargo_install_in_workflows.sh|false"
+  "ci/scripts/markdown_link_check.sh|false"
   "ci/scripts/rust_docs.sh|false"
 )
 
diff --git a/_sources/contributor-guide/testing.md.txt b/_sources/contributor-guide/testing.md.txt
index 44bd327013..2d0cad99cf 100644
--- a/_sources/contributor-guide/testing.md.txt
+++ b/_sources/contributor-guide/testing.md.txt
@@ -188,7 +188,12 @@ tested in the same way using the [doc_comment] crate. See the end of
 
 ## Documentation Link Checks
 
-Run the internal markdown link check locally:
+`./dev/rust_lint.sh` runs the internal markdown link check. If `lychee` is
+missing, the script installs the version pinned in
+`ci/scripts/utils/tool_versions.sh`. It uses an existing installation as is,
+even if the version differs from the pin.
+
+To run the check on its own:
 
 ```shell
 source ci/scripts/utils/tool_versions.sh
@@ -200,6 +205,7 @@ Notes:
 
 - The script is run with `bash` and is compatible with the default Bash on macOS (no `mapfile` dependency).
 - The CI configuration currently checks internal markdown links only. External `http(s)` and `mailto` links are excluded to avoid flaky failures.
+- The check only reports broken links. `./dev/rust_lint.sh --write` does not change them.
 
 When a link is broken, lychee prints the file and URL/path that failed. For example:
 
diff --git a/contributor-guide/testing.html b/contributor-guide/testing.html
index ce9e66599c..5cbbf15295 100644
--- a/contributor-guide/testing.html
+++ b/contributor-guide/testing.html
@@ -568,7 +568,11 @@ tested in the same way using the <a class="reference external" href="https://doc
 </section>
 <section id="documentation-link-checks">
 <h2>Documentation Link Checks<a class="headerlink" href="#documentation-link-checks" title="Link to this heading">#</a></h2>
-<p>Run the internal markdown link check locally:</p>
+<p><code class="docutils literal notranslate"><span class="pre">./dev/rust_lint.sh</span></code> runs the internal markdown link check. If <code class="docutils literal notranslate"><span class="pre">lychee</span></code> is
+missing, the script installs the version pinned in
+<code class="docutils literal notranslate"><span class="pre">ci/scripts/utils/tool_versions.sh</span></code>. It uses an existing installation as is,
+even if the version differs from the pin.</p>
+<p>To run the check on its own:</p>
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">source</span><span class="w"> </span>ci/scripts/utils/tool_versions.sh
 cargo<span class="w"> </span>install<span class="w"> </span>lychee<span class="w"> </span>--locked<span class="w"> </span>--version<span class="w"> </span><span class="s2">&quot;</span><span class="si">${</span><span class="nv">LYCHEE_VERSION</span><span class="si">}</span><span class="s2">&quot;</span>
 bash<span class="w"> </span>ci/scripts/markdown_link_check.sh
@@ -578,6 +582,7 @@ bash<span class="w"> </span>ci/scripts/markdown_link_check.sh
 <ul class="simple">
 <li><p>The script is run with <code class="docutils literal notranslate"><span class="pre">bash</span></code> and is compatible with the default Bash on macOS (no <code class="docutils literal notranslate"><span class="pre">mapfile</span></code> dependency).</p></li>
 <li><p>The CI configuration currently checks internal markdown links only. External <code class="docutils literal notranslate"><span class="pre">http(s)</span></code> and <code class="docutils literal notranslate"><span class="pre">mailto</span></code> links are excluded to avoid flaky failures.</p></li>
+<li><p>The check only reports broken links. <code class="docutils literal notranslate"><span class="pre">./dev/rust_lint.sh</span> <span class="pre">--write</span></code> does not change them.</p></li>
 </ul>
 <p>When a link is broken, lychee prints the file and URL/path that failed. For example:</p>
 <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>[docs/source/user-guide/cli/overview.md]:
diff --git a/searchindex.js b/searchindex.js
index 519ec9a114..45e67e643a 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles":{"!=":[[77,"op-neq"]],"!~":[[77,"op-re-not-match"]],"!~*":[[77,"op-re-not-match-i"]],"!~~":[[77,"id19"]],"!~~*":[[77,"id20"]],"#":[[77,"op-bit-xor"]],"%":[[77,"op-modulo"]],"&":[[77,"op-bit-and"]],"(relation, name) tuples in logical fields and logical columns are unique":[[16,"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]],"*":[[77,"op-multiply"]],"+":[[77,"op-plus"]],"-":[[77,"op-minus"]],"/":[[77,"op-divide"]],"1. Array Literal Con [...]
\ No newline at end of file
+Search.setIndex({"alltitles":{"!=":[[77,"op-neq"]],"!~":[[77,"op-re-not-match"]],"!~*":[[77,"op-re-not-match-i"]],"!~~":[[77,"id19"]],"!~~*":[[77,"id20"]],"#":[[77,"op-bit-xor"]],"%":[[77,"op-modulo"]],"&":[[77,"op-bit-and"]],"(relation, name) tuples in logical fields and logical columns are unique":[[16,"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]],"*":[[77,"op-multiply"]],"+":[[77,"op-plus"]],"-":[[77,"op-minus"]],"/":[[77,"op-divide"]],"1. Array Literal Con [...]
\ No newline at end of file


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datafusion.apache.org
For additional commands, e-mail: commits-help@datafusion.apache.org