From a43cab83755319e0e0c13a43583367a7b21af528 Mon Sep 17 00:00:00 2001
From: Frank Harkins <frankharkins@hotmail.co.uk>
Date: Tue, 24 Sep 2024 16:17:29 +0100
Subject: [PATCH] Wait for docker pull in CI (#2023)

CI can fail if `docker pull ...` takes longer than expected. This PR
adds a `--pull-only` option to `./start`, then waits for it to complete
in CI.
---
 .github/workflows/main.yml | 5 ++++-
 start                      | 4 ++++
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 94d85686cc..6c9f5d8321 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -51,11 +51,14 @@ jobs:
         with:
           files: docs/**/*.{md,mdx,ipynb}
           separator: "\n"
+      - name: Pull preview image
+        if: steps.changed-docs-files.outputs.any_changed == 'true'
+        run: ./start --pull-only
       - name: Start local Docker preview
         if: steps.changed-docs-files.outputs.any_changed == 'true'
         run: |
           ./start --apis &
-          sleep 20
+          sleep 1
       - name: Check that pages render
         if: steps.changed-docs-files.outputs.any_changed == 'true'
         run: |
diff --git a/start b/start
index d7927440f7..c79cffe800 100755
--- a/start
+++ b/start
@@ -27,6 +27,10 @@ def skip_apis() -> tuple[str]:
     return ("-v", "/home/node/app/docs/api")
 
 def main() -> None:
+    if "--pull-only" in sys.argv:
+        subprocess.run(["docker", "pull", IMAGE], check=True)
+        sys.exit(0)
+
     print(
         "Warning: this may be using an outdated version of the app. Run "
         + f"`docker pull {IMAGE}` to check for updates.",