From 0d797889ffc75719945391e7083d8efb463dd2ad Mon Sep 17 00:00:00 2001 From: bitzge <4791819+bitzge@users.noreply.github.com> Date: Sat, 18 Feb 2023 16:37:30 +0100 Subject: [PATCH] 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 000000000..f68fc2036 --- /dev/null +++ b/changelog/10690.doc.rst @@ -0,0 +1 @@ +Add CI and BUILD_NUMBER environment variables in documentation \ No newline at end of file diff --git a/doc/en/reference/reference.rst b/doc/en/reference/reference.rst index 288a4050d..c766a77b7 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