release: remove CI environment variables

pytest auto-detects and uses more verbose output when running in CI.

Change our release script to forcefully remove those environment variables before running `regendoc`, because we do not want extra verbose output in the user documentation.

Author: nicoddemus

scripts/release.py

@@ -79,9 +79,19 @@ def announce(version: str, template_name: str, doc_version: str) -> None:
 def regen(version: str) -> None:
     """Call regendoc tool to update examples and pytest output in the docs."""
     print(f"{Fore.CYAN}[generate.regen] {Fore.RESET}Updating docs")
+    env = os.environ.copy()
+
+    # Force setuptools-scm to use the requested version for the package.
+    env["SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST"] = version
+
+    # Remove CI markers: pytest auto-detects those and uses more verbose output, which is undersirable
+    # for the example documentation.
+    env.pop("CI", None)
+    env.pop("BUILD_NUMBER", None)
+
     check_call(
         ["tox", "-e", "regen"],
-        env={**os.environ, "SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST": version},
+        env=env
     )
 
 

src/_pytest/compat.py

@@ -310,6 +310,7 @@ def __call__(self) -> bool:
 def running_on_ci() -> bool:
     """Check if we're currently running on a CI system."""
     # Only enable CI mode if one of these env variables is defined and non-empty.
+    # Note: review `scripts/release.py` in case this list is changed.
     env_vars = ["CI", "BUILD_NUMBER"]
     return any(os.environ.get(var) for var in env_vars)