From ed417226423ac9edfe5052fe56b673767a8baf71 Mon Sep 17 00:00:00 2001
From: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com>
Date: Mon, 26 Oct 2026 11:17:46 +0000
Subject: [PATCH] docs: explain the v2.24 ignore and database path changes

---
 action.yml | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/action.yml b/action.yml
index 40be2574..ad78ea9b 100644
--- a/action.yml
+++ b/action.yml
@@ -96,6 +96,16 @@ inputs:
         a submodule's path (if desired) but not hidden directories.
       - **As of v2.12**, glob patterns are supported here.
         All asterisk characters (`*`) were previously literal.
+      - **As of v2.24**, a path only matches relative to the [`repo-root`](#repo-root).
+        For example, `build` ignores `build/` but not `src/build/`.
+        Use `**/` to ignore a folder at any depth.
+
+      !!! example
+
+          ``` yaml
+          # ignore every folder named build, and the .github folder
+          ignore: '**/build|.github'
+          ```
     required: false
     default: '.github'
   ignore-tidy:
@@ -153,7 +163,11 @@ inputs:
     required: false
     default: 'true'
   database:
-    description: The directory containing compilation database (like compile_commands.json) file.
+    description: |
+      The directory containing compilation database (like compile_commands.json) file.
+
+      **As of v2.24**, a relative path is relative to the runner's `GITHUB_WORKSPACE`,
+      not to the [`repo-root`](#repo-root).
     required: false
     default: ""
   extra-args: