From b44973c155159d6d8c6a62da22e4fe43b1f85869 Mon Sep 17 00:00:00 2001 From: nightcityblade Date: Sat, 22 Aug 2026 23:25:56 +0800 Subject: [PATCH] GH-32503: [Docs][Benchmarking] Document pull request benchmark hooks --- docs/source/developers/benchmarks.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/source/developers/benchmarks.rst b/docs/source/developers/benchmarks.rst index ce1b993e26d4..111edb4c6ec0 100644 --- a/docs/source/developers/benchmarks.rst +++ b/docs/source/developers/benchmarks.rst @@ -51,6 +51,27 @@ Additionally a full CMake build directory may be specified. archery benchmark run $HOME/arrow/cpp/release-build +Benchmarking a pull request +=========================== + +To run the remote benchmark suite for a pull request, add this comment to the +pull request: + +.. code-block:: text + + @ursabot please benchmark + +The bot schedules benchmark runs for the pull request commit. When they finish, +Conbench posts a report comparing the pull request (the contender) with its base +commit (the baseline). + +The benchmark jobs use the environment variables and build hooks in +``dev/conbench_envs`` from the commit being tested. This means that changes to +``benchmarks.env`` or ``hooks.sh`` can be tested in the same pull request. See +the `benchmark build environment and hooks documentation +`_ for details and +the requirements for changing existing hooks. + Comparison ==========