From 07f38602c8fcc7ad437eea31596eb5761b221af2 Mon Sep 17 00:00:00 2001
From: Eberhard Beilharz <eb1@sil.org>
Date: Mon, 12 May 2025 18:17:05 +0200
Subject: [PATCH] docs(common): document `builder_is_ci_*` functions

Fixes: #13886
Test-bot: skip
---
 docs/builder.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/docs/builder.md b/docs/builder.md
index 700567b531..c0b889ce9f 100644
--- a/docs/builder.md
+++ b/docs/builder.md
@@ -928,6 +928,50 @@ fi
 
 --------------------------------------------------------------------------------
 
+## `builder_is_ci_build` function
+
+Returns `true` (aka 0) if the current build is running in CI, as a pull
+request test, as a mainline branch test, or as a release build.
+
+### Usage
+
+```bash
+if builder_is_ci_build; then
+  ...
+fi
+```
+
+--------------------------------------------------------------------------------
+
+## `builder_is_ci_release_build` function
+
+Returns `true` (aka 0) if the current build is running as a release build in CI
+
+### Usage
+
+```bash
+if builder_is_ci_release_build; then
+  ...
+fi
+```
+
+--------------------------------------------------------------------------------
+
+## `builder_is_ci_test_build` function
+
+Returns `true` (aka 0) if the current build is running in CI, as a pull
+request test, or as a mainline branch test.
+
+### Usage
+
+```bash
+if builder_is_ci_test_build; then
+  ...
+fi
+```
+
+--------------------------------------------------------------------------------
+
 ## `builder_parse` function
 
 Initializes a build.sh script, parses command line. Will abort the script if