feat!: allow specifying the parallelism limit for buildkit (#41)

Author: MoisesGSalas

.github/workflows/build.yml

@@ -19,11 +19,11 @@ on:
         description: 'The service name to build'
         required: true
         type: string
-      ENABLE_LIMIT_BUILDKIT_PARALLELISM:
+      BUILDKIT_MAX_PARALLELISM:
         description: 'Enable buildkit parallelism limit to decrease resource usage. Default is true'
         required: false
-        type: boolean
-        default: true
+        type: number
+        default: 0
       RUNNER_WORKFLOW_LABEL:
         description: 'The label of the runner workflow to run'
         required: false
@@ -131,10 +131,10 @@ jobs:
           tutor picasso run-extra-commands
 
       - name: Limit build parallelism to decrease resource usage
-        if: ${{ inputs.ENABLE_LIMIT_BUILDKIT_PARALLELISM }}
+        if: ${{ inputs.BUILDKIT_MAX_PARALLELISM }}
         run: |
           echo "[worker.oci]
-          max-parallelism = 3" > buildkit.toml
+          max-parallelism = ${{ inputs.BUILDKIT_MAX_PARALLELISM }}" > buildkit.toml
           docker buildx create --use --node=limitparallelsteps --driver=docker-container --config=./buildkit.toml
 
       - name: Configure AWS credentials

README.rst

@@ -84,9 +84,9 @@ Before using the workflow, ensure that you have set up the following configurati
      - The service name to build, e.g., ``openedx``. This can be any service recognized by the tutor ecosystem.
      - string
      - Input
-   * - ENABLE_LIMIT_BUILDKIT_PARALLELISM (Optional)
-     - Enables limiting parallelism with buildkit to decrease resource consumption for those setups with low-powered machines. Default is ``true``.
-     - boolean
+   * - BUILDKIT_MAX_PARALLELISM (Optional)
+     - Configure the maximum parallelism for your builds. Default is ``0`` (no limit).
+     - number
      - Input
    * - RUNNER_WORKFLOW_LABEL (Optional)
      - The label of the runner workflow to use. Default is ``ubuntu-24.04``.
@@ -128,6 +128,18 @@ To use the Picasso Workflow, follow these steps:
 
 3. You can also set up a custom trigger for the workflow based on your project requirements.
 
+..
+
+    **Note**
+
+    When attempting to build an MFE image it might be possible to exhaust the resources
+    on the GitHub runner. You can specify a lower value of ``BUILDKIT_MAX_PARALLELISM``
+    to reduce the amount of resources used, if that isn't enough you can use a
+    different runner (e.g. a hosted `large runner`_) via the
+    ``RUNNER_WORKFLOW_LABEL`` input.
+
+.. _large runner: https://docs.github.com/en/actions/using-github-hosted-runners/using-larger-runners
+
 Getting Help
 ************