From 3e4cb9837156d982a25ea2dc74aa0c236c7edc99 Mon Sep 17 00:00:00 2001 From: bitzge <4791819+bitzge@users.noreply.github.com> Date: Sat, 18 Feb 2023 22:52:14 +0100 Subject: [PATCH] [7.2.x] add CI and BUILD_NUMBER env var in docs --- changelog/10690.doc.rst | 1 + doc/en/reference/reference.rst | 8 ++++++++ 2 files changed, 9 insertions(+) create mode 100644 changelog/10690.doc.rst diff --git a/changelog/10690.doc.rst b/changelog/10690.doc.rst new file mode 100644 index 00000000000..faf61b3cc44 --- /dev/null +++ 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 index b7bd4d1199a..bbad27e09cd 100644 --- 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