Skip to content

Commit 3c80cef

Browse files
[Doc] Introduce CI Workflow Management with BookKeeper Bot (apache#4674)
1 parent ae2c889 commit 3c80cef

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

site3/website/src/pages/community/coding-guide.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,3 +83,17 @@ Apache BookKeeper is a low latency system. So it is implemented as a purely asyn
8383
### Backwards Compatibility
8484
* 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.
8585
* Metadata formats and data formats should support backwards compatibility.
86+
87+
### CI Workflow Management with BookKeeper Bot
88+
89+
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.
90+
91+
**Usage Guidelines:**
92+
- The bot is triggered when a PR comment contains `/bkbot`.
93+
- Supported commands:
94+
- `/bkbot rerun`: Reruns the latest failed, cancelled, timed out, or skipped workflow runs for the PR head SHA.
95+
- `/bkbot rerun <keyword>`: Reruns jobs in the latest runs whose name matches the specified keyword.
96+
- `/bkbot stop` or `/bkbot cancel`: Cancels all running (queued/in_progress) workflow runs associated with the PR.
97+
- The bot cannot rerun jobs from workflows that are currently running.
98+
99+
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.

0 commit comments

Comments
 (0)