Skip to content

GH-32503: [Docs][Benchmarking] Document pull request benchmark hooks #50953

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nightcityblade wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −0
Open

GH-32503: [Docs][Benchmarking] Document pull request benchmark hooks #50953

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/source/developers/benchmarks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://github.com/apache/arrow/tree/main/dev/conbench_envs>`_ for details and
the requirements for changing existing hooks.

Comparison
==========

Expand Down