nix(loadtest): add comment on loadtest-against

2026-06-22 12:55:56 -05:00
parent ffe4cc6f42
commit ded9be6774
1 changed files with 3 additions and 0 deletions
@@ -192,6 +192,9 @@ let
            Run the vegeta loadtest against every target branch and HEAD:
            - once on the every <target-#> branch
            - once in the current worktree
+
+            Note that the Nix tooling is always taken from the HEAD branch, while the PostgREST binary is taken from the target branch.
+            For a discussion on why this is set up like this, see https://github.com/PostgREST/postgrest/pull/5013#discussion_r3431508441.
          '';
        args = [
          "ARG_POSITIONAL_INF([target], [Commit-ish reference to compare with], 1)"