ci: fix wiki deletion with buffer update

[alandtse]

Andrew-Chen-Wang/github-wiki-action@v5.0.4 fixed deletions not propagating and introduced correct behavior of only keeping what was in the wiki directory.

Summary by CodeRabbit

• Chores
  • Updated wiki update workflow to attempt cloning existing wiki content before creating a new directory.
  • Falls back to initializing an empty wiki directory and logs an informational message if no wiki is found.
  • Improves resilience and reduces unnecessary empty directory creation during wiki preparation.

[coderabbitai]

📝 Walkthrough

Walkthrough

The GitHub Actions workflow now attempts to shallow-clone the existing wiki into wiki-content using the repo token; if the clone fails (wiki absent or error), it falls back to creating an empty wiki-content directory and logs the outcome. (≤50 words)

Changes

Cohort / File(s)	Summary
Wiki Workflow Setup .github/workflows/update-buffers-wiki.yaml	Replace unconditional creation of wiki-content with a conditional step: attempt git clone --depth 1 of the wiki using the GitHub token, and on failure create an empty wiki-content directory and emit an informational message. Control flow around wiki preparation was adjusted.

Sequence Diagram(s)

sequenceDiagram
    participant Runner as GitHub Actions Runner
    participant WikiRepo as GitHub Wiki Repo
    participant FS as Runner Filesystem (wiki-content)

    Runner->>WikiRepo: Attempt shallow clone (depth 1) using token
    alt clone succeeds
        WikiRepo-->>Runner: repo data
        Runner->>FS: populate `wiki-content` with cloned files
        Runner-->>Runner: proceed to update/upload wiki
    else clone fails
        Runner-->>Runner: log "wiki not found" info
        Runner->>FS: mkdir `wiki-content`
        Runner-->>Runner: proceed with empty wiki-content flow
    end

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• ci: add automated wiki buffer documentation workflow #1659: Modifies the same .github/workflows/update-buffers-wiki.yaml workflow to create and upload Buffers.md; directly related to wiki setup behavior.

Suggested reviewers

• davo0411

Poem

🐰 I hopped into CI with a curious grin,
Tried to clone a wiki, to pull content in.
If the repo was missing, no panic, no rue—
I make a new folder and carry on through.
Happy hops for docs, with a token or two! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'ci: fix wiki deletion with buffer update' directly addresses the main change: fixing wiki deletion behavior in the CI workflow when updating buffers.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 actionlint (1.7.11)

.github/workflows/update-buffers-wiki.yaml

could not read ".github/workflows/update-buffers-wiki.yaml": open .github/workflows/update-buffers-wiki.yaml: no such file or directory

🔧 YAMLlint (1.38.0)

.github/workflows/update-buffers-wiki.yaml

[Errno 2] No such file or directory: '.github/workflows/update-buffers-wiki.yaml'

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

No actionable suggestions for changed features.

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/workflows/update-buffers-wiki.yaml:
- Around line 35-37: The checkout step "Checkout existing wiki" currently uses
`git clone ... || mkdir -p wiki-content`, which masks clone failures by creating
an empty directory; change this so the job fails on clone errors instead of
silently bootstrapping an empty wiki: remove the `|| mkdir -p wiki-content`
fallback (or replace it with an explicit conditional that only creates
wiki-content when you intentionally intend to initialize a brand-new wiki), and
ensure the `git clone` command's non-zero exit causes the workflow to fail so
downstream upload steps cannot accidentally wipe unrelated pages.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 140e155e-3fba-409c-900b-07bc110eac20

📥 Commits

Reviewing files that changed from the base of the PR and between 7a6ce1b and a8d7ded.

📒 Files selected for processing (1)

• .github/workflows/update-buffers-wiki.yaml

[github-actions]

✅ A pre-release build is available for this PR:
Download

[coderabbitai]

♻️ Duplicate comments (1)

.github/workflows/update-buffers-wiki.yaml (1)

38-42: ⚠️ Potential issue | 🔴 Critical

Don’t treat all git ls-remote failures as “wiki missing.”

This still masks auth/network/transient GitHub failures by bootstrapping an empty wiki-content. With the v5 wiki action, that can delete unrelated pages because only files present in wiki-content are kept. Only initialize an empty directory for the specific “wiki repo does not exist” case; otherwise fail the job.

Suggested fix

             - name: Checkout existing wiki
               run: |
+                  set -euo pipefail
                   WIKI_URL="https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.wiki.git"
-                  if git ls-remote --exit-code "$WIKI_URL" &>/dev/null; then
+                  if git ls-remote --exit-code "$WIKI_URL" &>/dev/null; then
                       git clone --depth=1 "$WIKI_URL" wiki-content
                   else
-                      echo "Wiki does not exist yet; initializing empty wiki-content directory."
-                      mkdir -p wiki-content
+                      status=$?
+                      if [ "$status" -eq 2 ]; then
+                          echo "Wiki does not exist yet; initializing empty wiki-content directory."
+                          mkdir -p wiki-content
+                      else
+                          echo "Error: failed to query existing wiki repository." >&2
+                          exit "$status"
+                      fi
                   fi
               shell: bash

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In @.github/workflows/update-buffers-wiki.yaml around lines 38 - 42, The current
block treats any failure of git ls-remote "$WIKI_URL" as “wiki missing”; change
it to capture git ls-remote stderr (e.g., git ls-remote "$WIKI_URL" 2>err.txt)
and only bootstrap wiki-content when the error clearly indicates the wiki repo
does not exist (match stderr for "Repository not found" / "not found" or similar
GitHub-not-exist messages); on success, git clone --depth=1 "$WIKI_URL"
wiki-content; on other failures (auth/network/transient errors) print the
captured stderr and exit non‑zero so the job fails instead of creating an empty
wiki-content. Ensure the logic replaces the current if git ls-remote ...
&>/dev/null branch and still uses the same "$WIKI_URL" and wiki-content
identifiers.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In @.github/workflows/update-buffers-wiki.yaml:
- Around line 38-42: The current block treats any failure of git ls-remote
"$WIKI_URL" as “wiki missing”; change it to capture git ls-remote stderr (e.g.,
git ls-remote "$WIKI_URL" 2>err.txt) and only bootstrap wiki-content when the
error clearly indicates the wiki repo does not exist (match stderr for
"Repository not found" / "not found" or similar GitHub-not-exist messages); on
success, git clone --depth=1 "$WIKI_URL" wiki-content; on other failures
(auth/network/transient errors) print the captured stderr and exit non‑zero so
the job fails instead of creating an empty wiki-content. Ensure the logic
replaces the current if git ls-remote ... &>/dev/null branch and still uses the
same "$WIKI_URL" and wiki-content identifiers.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: de2b818b-aeb7-45f7-9222-af5a7f274be3

📥 Commits

Reviewing files that changed from the base of the PR and between a8d7ded and b5cc6ed.

📒 Files selected for processing (1)

• .github/workflows/update-buffers-wiki.yaml