Add CI and BUILD_NUMBER env var in docs (#10749)

pytest-dev · Feb 18, 2023 · 051f8f1 · 051f8f1
1 parent 31ad577
commit 051f8f1
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/changelog/10690.doc.rst b/changelog/10690.doc.rst
@@ -0,0 +1 @@
+Added `CI` and `BUILD_NUMBER` environment variables to the documentation.
diff --git a/doc/en/reference/reference.rst b/doc/en/reference/reference.rst
@@ -1047,6 +1047,14 @@ Environment Variables
 
 Environment variables that can be used to change pytest's behavior.
 
+.. envvar:: CI
+
+When set (regardless of value), pytest acknowledges that is running in a CI process. Alterative to ``BUILD_NUMBER`` variable.
+
+.. envvar:: BUILD_NUMBER
+
+When set (regardless of value), pytest acknowledges that is running in a CI process. Alterative to CI variable.
+
 .. envvar:: PYTEST_ADDOPTS
 
 This contains a command-line (parsed by the py:mod:`shlex` module) that will be **prepended** to the command line given