From 08de16d1387eb5ead9cfdd413a33d3671ee24d68 Mon Sep 17 00:00:00 2001 From: Gustavo Madeira Santana Date: Fri, 10 Apr 2026 18:59:05 -0400 Subject: [PATCH] docs: document Telegram QA lane prerequisites --- docs/concepts/qa-e2e-automation.md | 14 ++++++++++++++ docs/help/testing.md | 3 +++ 2 files changed, 17 insertions(+) diff --git a/docs/concepts/qa-e2e-automation.md b/docs/concepts/qa-e2e-automation.md index 18f3a0ee63a..fa2e022f92b 100644 --- a/docs/concepts/qa-e2e-automation.md +++ b/docs/concepts/qa-e2e-automation.md @@ -64,6 +64,20 @@ the real Matrix plugin inside a QA gateway child. The live transport lane keeps the child config scoped to the transport under test, so Matrix runs without `qa-channel` in the child config. +For a transport-real Telegram smoke lane, run: + +```bash +pnpm openclaw qa telegram +``` + +That lane targets one real private Telegram group instead of provisioning a +disposable server. It requires `OPENCLAW_QA_TELEGRAM_GROUP_ID`, +`OPENCLAW_QA_TELEGRAM_DRIVER_BOT_TOKEN`, and +`OPENCLAW_QA_TELEGRAM_SUT_BOT_TOKEN`, plus two distinct bots in the same +private group. The SUT bot must have a Telegram username, and bot-to-bot +observation works best when both bots have Bot-to-Bot Communication Mode +enabled in `@BotFather`. + Live transport lanes now share one smaller contract instead of each inventing their own scenario list shape: diff --git a/docs/help/testing.md b/docs/help/testing.md index 19fa2d965c2..38f98bb203e 100644 --- a/docs/help/testing.md +++ b/docs/help/testing.md @@ -72,6 +72,9 @@ These commands sit beside the main test suites when you need QA-lab realism: - Writes a Matrix QA report, summary, and observed-events artifact under `.artifacts/qa-e2e/...`. - `pnpm openclaw qa telegram` - Runs the Telegram live QA lane against a real private group using the driver and SUT bot tokens from env. + - Requires `OPENCLAW_QA_TELEGRAM_GROUP_ID`, `OPENCLAW_QA_TELEGRAM_DRIVER_BOT_TOKEN`, and `OPENCLAW_QA_TELEGRAM_SUT_BOT_TOKEN`. The group id must be the numeric Telegram chat id. + - Requires two distinct bots in the same private group, with the SUT bot exposing a Telegram username. + - For stable bot-to-bot observation, enable Bot-to-Bot Communication Mode in `@BotFather` for both bots and ensure the driver bot can observe group bot traffic. - Writes a Telegram QA report, summary, and observed-messages artifact under `.artifacts/qa-e2e/...`. Live transport lanes share one standard contract so new transports do not drift: