This is an automated email from the ASF dual-hosted git repository.
lhotari pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/bookkeeper.git
The following commit(s) were added to refs/heads/master by this push:
new 3c80cefa50 [Doc] Introduce CI Workflow Management with BookKeeper Bot
(#4674)
3c80cefa50 is described below
commit 3c80cefa50173924453985d536f91fa845f4161b
Author: Xiangying Meng <[email protected]>
AuthorDate: Mon Oct 27 20:45:30 2025 +0800
[Doc] Introduce CI Workflow Management with BookKeeper Bot (#4674)
---
site3/website/src/pages/community/coding-guide.md | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/site3/website/src/pages/community/coding-guide.md
b/site3/website/src/pages/community/coding-guide.md
index 1c3e2d2ebb..faf45f9bae 100644
--- a/site3/website/src/pages/community/coding-guide.md
+++ b/site3/website/src/pages/community/coding-guide.md
@@ -83,3 +83,17 @@ Apache BookKeeper is a low latency system. So it is
implemented as a purely asyn
### Backwards Compatibility
* Wire protocol should support backwards compatibility to enable no-downtime
upgrades. This means the servers **MUST** be able to support requests from both
old and new clients simultaneously.
* Metadata formats and data formats should support backwards compatibility.
+
+### CI Workflow Management with BookKeeper Bot
+
+To facilitate easier CI workflow management and improve contributor
experience, Apache BookKeeper utilizes a GitHub Actions bot ("BookKeeper Bot")
that enables maintainers and contributors to rerun or cancel workflows directly
via PR comments.
+
+**Usage Guidelines:**
+- The bot is triggered when a PR comment contains `/bkbot`.
+- Supported commands:
+ - `/bkbot rerun`: Reruns the latest failed, cancelled, timed out, or
skipped workflow runs for the PR head SHA.
+ - `/bkbot rerun <keyword>`: Reruns jobs in the latest runs whose name
matches the specified keyword.
+ - `/bkbot stop` or `/bkbot cancel`: Cancels all running
(queued/in_progress) workflow runs associated with the PR.
+- The bot cannot rerun jobs from workflows that are currently running.
+
+Using these commands streamlines workflow/job management, reduces manual
effort, and helps to address CI failures caused by infrastructure flakiness.
Please use the bot commands as appropriate to manage CI jobs related to your
PRs.
\ No newline at end of file
