Update release preparation to scripts/release

.dockerignore

@@ -0,0 +1,85 @@
+# Patterns aligned with .gitignore — reduces Docker build context size.
+# See .gitignore for original references and rationale.
+
+# OS
+.DS_Store
+.AppleDouble
+.LSOverride
+._*
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.AppleDB
+.AppleDesktop
+.apdisk
+
+# IDE / editors
+*.iml
+.idea/
+*~
+/.project
+/.pydevproject
+/.vscode
+
+# Virtualenv / local env
+.venv*/
+env/
+.envrc
+.python-version
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Test / coverage
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+junit-*.xml
+.pytest_cache/
+
+# Translations / logs
+*.mo
+*.pot
+*.log
+
+# Docs build
+docs/_build/
+
+# PyBuilder
+target/
+
+# Pickles
+*.pk
+
+# Rally-specific
+.rally_it/
+NOTICE.txt
+recipes/ccr/ccr-target-hosts.json
+tracks/

.pre-commit-config.yaml

@@ -49,5 +49,15 @@ repos:
             "-j0",
             "--rcfile=.pylintrc",
           ]
-        exclude: ^(docs/|changelog.py)
+        exclude: ^(docs/|scripts/release/changelog\.py)
         require_serial: true
+
+  # Shell scripts: release tooling and repo githooks. Widen to all *.sh once legacy
+  # scripts under .buildkite/, recipes/, repo root, etc. pass shellcheck.
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.11.0.1
+    hooks:
+      - id: shellcheck
+        name: shellcheck
+        args: [-x]
+        files: (^scripts/release/.*\.sh$)|(^scripts/githooks/(pre-commit|post-commit)$)

CONTRIBUTING.md

@@ -38,6 +38,19 @@ If you want to get started in the project, a good idea is to check issues labele
 You will need to fork the Rally repository and clone it to your local machine. See 
 the [Github help page](https://help.github.com/articles/fork-a-repo) for help.
 
+Optional: use this repository’s hooks under `scripts/githooks` (instead of `.git/hooks`):
+
+```bash
+make install-git-hooks
+```
+
+This sets `git config core.hooksPath scripts/githooks` in your local clone. You can run the same `git config` command by hand if you prefer.
+
+* **`pre-commit`** — runs `uv run -- pre-commit run` (same as `make pre-commit`) on staged files before the commit is created. Requires [uv](https://docs.astral.sh/uv/) and a dev environment (`make install` or `make venv`).
+* **`post-commit`** — strips `Co-authored-by` / `Made-with: Cursor` trailers Cursor may add; it runs `git commit --amend` when the message changes, so the latest commit’s hash can change.
+
+To stop using these hooks in this clone, run `git config --unset core.hooksPath`. The post-commit hook sets `GIT_CURSOR_HOOK_AMENDING` internally to avoid re-running while amending; you normally do not need to set that variable yourself.
+
 ### Importing the project into IntelliJ IDEA
 
 Rally builds using virtualenv. When importing into IntelliJ you will need to define an appropriate Python SDK, which is provided by virtualenv.
@@ -60,7 +73,7 @@ Once your changes and tests are ready to submit for review:
 
     Ensure that all tests pass by running `make check-all`. This runs sequentially lint checks, unit tests and integration tests. These can be executed in isolation using `make lint`, `make test` and `make it` respectively, in case you need to iterate over a subset of tests.
 
-    Note: Integration tests are much slower than unit tests and require `docker-compose`.
+    Note: Integration tests are much slower than unit tests and require `docker compose`. They also require **Java 21**; set `JAVA_HOME` (or `JAVA21_HOME`) to match.
 
 3. Sign the Contributor License Agreement
 
@@ -79,6 +92,10 @@ Then sit back and wait. There will probably be discussion about the pull request
 
 Note: Contributors belonging to the "Elastic" organization on Github can merge PRs themselves after getting a "LGTM" (Looks good to me); this workflow is similar to the established one in the Elasticsearch project.
 
+## Release process (maintainers)
+
+Follow the internal **Rally Release Process** runbook: https://codex.elastic.dev/r/elasticsearch-team/teams/performance/runbooks/rally-release-process
+
 # Contributing to the Rally codebase
 
 **Repository:** [https://github.com/elastic/rally](https://github.com/elastic/rally)

Makefile

@@ -26,8 +26,6 @@ PY_VERSION := $(shell jq -r '.python_versions.DEFAULT_PY_VER' .ci/variables.json
 export UV_PYTHON := $(PY_VERSION)
 export UV_PROJECT_ENVIRONMENT := $(VIRTUAL_ENV)
 
-PRE_COMMIT_HOOK_PATH := .git/hooks/pre-commit
-
 LOG_CI_LEVEL := INFO
 
 # --- Global goals ---
@@ -57,7 +55,7 @@ check-all: all
 	format \
 	pre-commit \
 	precommit \
-	install-pre-commit \
+	install-git-hooks \
 	docs \
 	serve-docs \
 	clean-docs \
@@ -143,14 +141,9 @@ lint: venv
 precommit pre-commit: venv
 	uv run -- pre-commit run
 
-# It install a pre-commit hook in the project .git dir so modified files are checked before creating every commit.
-install-pre-commit: $(PRE_COMMIT_HOOK_PATH)
-
-$(PRE_COMMIT_HOOK_PATH):
-	mkdir -p $(dir $@)
-	echo '#!/usr/bin/env $(SHELL)' > '$@'
-	echo 'make pre-commit' >> '$@'
-	chmod ugo+x '$@'
+# It points git at scripts/githooks (pre-commit + post-commit). Run from the repo root.
+install-git-hooks:
+	git config core.hooksPath scripts/githooks
 
 # pre-commit run also formats files, but let's keep `make format` for convenience.
 format: lint
@@ -217,11 +210,15 @@ benchmark: venv
 # --- Release goals ---
 
 release-checks: venv
-	$(VENV_ACTIVATE); ./release-checks.sh $(release_version) $(next_version)
+	@if [ -z "$(RELEASE_VERSION)" ]; then echo "error: set RELEASE_VERSION (e.g. make release-checks RELEASE_VERSION=2.13.0)" >&2; exit 1; fi
+	$(VENV_ACTIVATE); ./scripts/release/checks.sh $(RELEASE_VERSION)
 
-# usage: e.g. make release release_version=0.9.2 next_version=0.9.3
-release: venv release-checks clean docs lint test it
-	$(VENV_ACTIVATE); ./release.sh $(release_version) $(next_version)
+# usage: e.g. make release RELEASE_VERSION=2.13.0
+release:
+	@if [ -z "$(RELEASE_VERSION)" ]; then echo "error: set RELEASE_VERSION (e.g. make release RELEASE_VERSION=2.13.0)" >&2; exit 1; fi
+	./scripts/release/prepare-docker.sh $(RELEASE_VERSION)
+
+# --- Other goals ---
 
 # This is a shortcut for creating a shell running inside the project virtual environment.
 sh:

docs/developing.rst

@@ -8,6 +8,7 @@ Install the following software packages:
 
 * `uv <https://docs.astral.sh/uv/getting-started/installation/>`_ 
 * JDK version required to build Elasticsearch. Please refer to the `build setup requirements <https://github.com/elastic/elasticsearch/blob/main/CONTRIBUTING.md#contributing-to-the-elasticsearch-codebase>`_.
+  For running Rally's integration tests (e.g. ``make it`` or ``make it_tracks_compat``), ensure your environment uses **Java 21** (recent Rally versions use Java 21 in CI). Set ``JAVA_HOME`` or ``JAVA21_HOME`` accordingly.
 * `Docker <https://docs.docker.com/install/>`_ and on Linux additionally `docker-compose <https://docs.docker.com/compose/install/>`_.
 * `jq <https://stedolan.github.io/jq/download/>`_
 * git
@@ -36,7 +37,7 @@ Rally uses automatic code formatters. You can apply them by running ``make forma
 
 However, consider using editor integrations to do it automatically: you'll need to configure `black <https://black.readthedocs.io/en/stable/integrations/editors.html>`_ and `isort <https://github.com/PyCQA/isort/wiki/isort-Plugins>`_.
 
-Also consider running `pre-commit install` to run lint as part of your git commits.
+Also consider running ``make install-git-hooks`` to point git at ``scripts/githooks`` so lint runs on each commit (same as ``make pre-commit`` via the hook there).
 
 Automatic Updates
 ~~~~~~~~~~~~~~~~~
@@ -76,8 +77,3 @@ To get a rough understanding of Rally, it makes sense to get to know its key com
 * `Reporter`: A reporter tells us how the race went (currently only after the fact).
 
 There is a dedicated :doc:`tutorial on how to add new tracks to Rally</adding_tracks>`.
-
-How to contribute code
-----------------------
-
-See the `contributors guide <https://github.com/elastic/rally/blob/master/CONTRIBUTING.md>`_. We strive to be PEP-8 compliant but don't follow it to the letter.

docs/docker.rst

@@ -154,3 +154,4 @@ You can then build and test the image with::
 
     docker build --tag=custom-rally .
     docker run -ti custom-rally list tracks
+

pyproject.toml

@@ -35,7 +35,7 @@ classifiers = [
 ]
 ################################################################################################
 #
-# Adapt `create-notice.sh` whenever changing dependencies here.
+# Adapt `scripts/release/create-notice.sh` whenever changing dependencies here.
 #
 # That script grabs all license files so we include them in the notice file.
 #
@@ -92,6 +92,8 @@ dependencies = [
     "hatch==1.3.1",
     "hatchling==1.6.0",
     "wheel==0.46.2",
+    # Release Docker image pins the same pip (scripts/release/Dockerfile).
+    "pip==26.0.1",
 ]
 
 [project.optional-dependencies]
@@ -117,6 +119,7 @@ develop = [
     "pytest-httpserver==1.1.3",
     "sphinx==5.1.1",
     "furo==2022.06.21",
+    # Release image + prepare-docker venv pin the same version (scripts/release/Dockerfile, prepare-docker.sh).
     "github3.py==3.2.0",
     "pre-commit==2.20.0",
     "pylint==3.3.8",