From 2c9ce619dddcb8d7c930adbde5a7b22a9751bf07 Mon Sep 17 00:00:00 2001
From: Jakob Ackermann <jakob.ackermann@overleaf.com>
Date: Mon, 18 Aug 2025 17:02:28 +0200
Subject: [PATCH] [monorepo] document jenkins pipelines (#27954)

* [saas-e2e] reset database when db-migration files were removed

* [monorepo] document jenkins pipelines

* [monorepo] trim docs for jenkins pipelines

GitOrigin-RevId: 783ad94f05b36f4057e3ac6cc8b8c40f850e5d2f
---
 server-ce/test/Jenkinsfile | 9 +++++++++
 services/web/Jenkinsfile   | 9 +++++++++
 2 files changed, 18 insertions(+)

diff --git a/server-ce/test/Jenkinsfile b/server-ce/test/Jenkinsfile
index f246f6b75e..5c9ab0136e 100644
--- a/server-ce/test/Jenkinsfile
+++ b/server-ce/test/Jenkinsfile
@@ -1,3 +1,7 @@
+// Initialize variables to signal that a given stage finished.
+// We use them to build a graph of interconnected steps/dependencies.
+// - Incoming edges use "waitUntil" and reference the given variables of dependencies.
+// - Outgoing edges set the given variable to true.
 def job_copybara_done = false
 def job_npm_install_done = false
 def job_prefetch_custom_done = false
@@ -8,13 +12,17 @@ def job_server_pro_build_done = false
 pipeline {
   agent {
     node {
+      // Select a VM with the given tabel.
       label 'jenkins-agent-web'
+      // Use the monorepo checkout in /workspace.
       customWorkspace '/workspace'
     }
   }
 
   options {
+    // Print timestamp next to each log line.
     timestamps()
+    // Abort build after hitting first failure.
     parallelsAlwaysFailFast()
     timeout(time: 15, unit: 'MINUTES')
   }
@@ -220,6 +228,7 @@ pipeline {
     }
   }
   post {
+    // Ensure tear down of test containers, remove CE docker images, then run general Jenkins VM cleanup.
     cleanup {
       dir('server-ce/test') {
         sh 'make clean'
diff --git a/services/web/Jenkinsfile b/services/web/Jenkinsfile
index a5c605304c..9c98205e77 100644
--- a/services/web/Jenkinsfile
+++ b/services/web/Jenkinsfile
@@ -1,3 +1,7 @@
+// Initialize variables to signal that a given stage finished.
+// We use them to build a graph of interconnected steps/dependencies.
+// - Incoming edges use "waitUntil" and reference the given variables of dependencies.
+// - Outgoing edges set the given variable to true.
 def action_test_frontend_ct_build = false
 def action_build_deps = false
 def action_copy_external_pages = false
@@ -11,13 +15,17 @@ def action_build_production= false
 pipeline {
   agent {
     node {
+      // Select a VM with the given tabel.
       label 'jenkins-agent-web'
+      // Use the monorepo checkout in /workspace.
       customWorkspace '/workspace'
     }
   }
 
   options {
+    // Print timestamp next to each log line.
     timestamps()
+    // Abort build after hitting first failure.
     parallelsAlwaysFailFast()
     timeout(time: 15, unit: 'MINUTES')
   }
@@ -447,6 +455,7 @@ pipeline {
     }
   }
   post {
+    // Ensure tear down of test containers, then run general Jenkins VM cleanup.
     cleanup {
       dir('services/web') {
         sh 'make clean'