A high-throughput and memory-efficient inference and serving engine for LLMs
Only enable PR docs builds manually (#45262)
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Harry Mellor committed
Jun 11, 2026 at 11:14 UTC
432905d5d6b2efd53c434a47c35f7d3b0fb256d5
1 file changed
+20
-6
docs/pre_run_check.sh
+20
-6
@@ -3,6 +3,26 @@ if [ "$READTHEDOCS_VERSION_TYPE" != "external" ]; then
3
exit 0
4
fi
5
6
+# Use a GitHub token if provided to raise the API rate limit (60 -> 5000
7
+# requests/hour). Set GITHUB_TOKEN in the Read the Docs environment variables.
8
+CURL_AUTH=()
9
+if [ -n "$GITHUB_TOKEN" ]; then
10
+ CURL_AUTH=(-H "Authorization: Bearer $GITHUB_TOKEN")
11
+fi
12
+
13
+# Docs builds are now manually enabled via the 'build-docs' label.
14
+echo "Checking for the 'build-docs' label on PR #${READTHEDOCS_VERSION_NAME}..."
15
+LABELS=$(curl -sS "${CURL_AUTH[@]}" "https://api.github.com/repos/vllm-project/vllm/issues/${READTHEDOCS_VERSION_NAME}/labels" | python3 -c "import sys, json; print('\n'.join(l.get('name', '') for l in json.load(sys.stdin)))")
16
+if printf '%s\n' "$LABELS" | grep -qx "build-docs"; then
17
+ echo "PR has the 'build-docs' label; continuing build."
18
+ exit 0
19
+else
20
+ echo "PR does not have the 'build-docs' label; cancelling build."
21
+ # See https://docs.readthedocs.com/platform/latest/guides/build/skip-build.html for info on exit code
22
+ exit 183
23
+fi
24
+
25
+# Everything below this line is effectively disabled as a temporary measure.
26
echo "Checking for changes to docs-affecting files vs origin/main..."
27
DOCS_PATHS=(
28
docs/ # Actual docs content
@@ -24,12 +44,6 @@ echo "Checking pre-commit/pre-run-check status..."
44
MAX_WAIT=300
45
INTERVAL=60
46
ELAPSED=0
27
-# Use a GitHub token if provided to raise the API rate limit (60 -> 5000
28
-# requests/hour). Set GITHUB_TOKEN in the Read the Docs environment variables.
29
-CURL_AUTH=()
30
-if [ -n "$GITHUB_TOKEN" ]; then
31
- CURL_AUTH=(-H "Authorization: Bearer $GITHUB_TOKEN")
32
-fi
47
while :; do
48
RAW=$(curl -sS "${CURL_AUTH[@]}" -w "\n%{http_code}" "https://api.github.com/repos/vllm-project/vllm/commits/${READTHEDOCS_GIT_COMMIT_HASH}/check-runs?check_name=pre-run-check&filter=latest")
49
HTTP_CODE=$(printf %s "$RAW" | tail -n1)