Merge pull request #1240 from tahoe-lafs/support-triggered-image-builds

Support triggered image builds

Fixes: ticket:3958

.circleci/config.yml

@@ -11,8 +11,53 @@
 #
 version: 2.1
 
+# A template that can be shared between the two different image-building
+# workflows.
+.images: &IMAGES
+  jobs:
+    # Every job that pushes a Docker image from Docker Hub needs to provide
+    # credentials.  Use this first job to define a yaml anchor that can be
+    # used to supply a CircleCI job context which makes Docker Hub credentials
+    # available in the environment.
+    #
+    # Contexts are managed in the CircleCI web interface:
+    #
+    #  https://app.circleci.com/settings/organization/github/tahoe-lafs/contexts
+    - "build-image-debian-11": &DOCKERHUB_CONTEXT
+        <<: *DOCKERHUB_CONTEXT
+    - "build-image-ubuntu-20-04":
+        <<: *DOCKERHUB_CONTEXT
+    - "build-image-fedora-35":
+        <<: *DOCKERHUB_CONTEXT
+    - "build-image-oraclelinux-8":
+        <<: *DOCKERHUB_CONTEXT
+    # Restore later as PyPy38
+    #- "build-image-pypy27-buster":
+    #    <<: *DOCKERHUB_CONTEXT
+
+parameters:
+  # Control whether the image-building workflow runs as part of this pipeline.
+  # Generally we do not want this to run because we don't need our
+  # dependencies to move around all the time and because building the image
+  # takes a couple minutes.
+  #
+  # An easy way to trigger a pipeline with this set to true is with the
+  # rebuild-images.sh tool in this directory.  You can also do so via the
+  # CircleCI web UI.
+  build-images:
+    default: false
+    type: "boolean"
+
+  # Control whether the test-running workflow runs as part of this pipeline.
+  # Generally we do want this to run because running the tests is the primary
+  # purpose of this pipeline.
+  run-tests:
+    default: true
+    type: "boolean"
+
 workflows:
   ci:
+    when: "<< pipeline.parameters.run-tests >>"
     jobs:
       # Start with jobs testing various platforms.
       - "debian-11":
@@ -60,37 +105,10 @@ workflows:
           {}
 
   images:
-    # Build the Docker images used by the ci jobs.  This makes the ci jobs
-    # faster and takes various spurious failures out of the critical path.
-    triggers:
-      # Build once a day
-      - schedule:
-          cron: "0 0 * * *"
-          filters:
-            branches:
-              only:
-                - "master"
+    <<: *IMAGES
 
-    jobs:
-      # Every job that pushes a Docker image from Docker Hub needs to provide
-      # credentials.  Use this first job to define a yaml anchor that can be
-      # used to supply a CircleCI job context which makes Docker Hub
-      # credentials available in the environment.
-      #
-      # Contexts are managed in the CircleCI web interface:
-      #
-      #  https://app.circleci.com/settings/organization/github/tahoe-lafs/contexts
-      - "build-image-debian-11": &DOCKERHUB_CONTEXT
-          <<: *DOCKERHUB_CONTEXT
-      - "build-image-ubuntu-20-04":
-          <<: *DOCKERHUB_CONTEXT
-      - "build-image-fedora-35":
-          <<: *DOCKERHUB_CONTEXT
-      - "build-image-oraclelinux-8":
-          <<: *DOCKERHUB_CONTEXT
-      # Restore later as PyPy38
-      #- "build-image-pypy27-buster":
-      #    <<: *DOCKERHUB_CONTEXT
+    # Build as part of the workflow but only if requested.
+    when: "<< pipeline.parameters.build-images >>"
 
 
 jobs:

.circleci/rebuild-images.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+# Get your API token here:
+# https://app.circleci.com/settings/user/tokens
+API_TOKEN=$1
+shift
+
+# Name the branch you want to trigger the build for
+BRANCH=$1
+shift
+
+curl \
+    --verbose \
+    --request POST \
+    --url https://circleci.com/api/v2/project/gh/tahoe-lafs/tahoe-lafs/pipeline \
+    --header "Circle-Token: $API_TOKEN" \
+    --header "content-type: application/json" \
+    --data '{"branch":"'"$BRANCH"'","parameters":{"build-images":true,"run-tests":false}}'