Update readme and tests for example files

Author: shanejbrown

examples/README.rst

@@ -39,4 +39,9 @@ To contribute a new example configuration file, adhere to the following guidelin
    - If necessary, include a ``README.rst`` file in the same directory as the configuration file to provide additional details or instructions.
    - Any supporting files required for the configuration should be placed alongside the configuration file.
 
-Following these best practices ensures consistency, maintainability, and ease of use for all contributors and users.
+Following these best practices ensures consistency, maintainability, and ease of use for all contributors and users.
+
+Excluding Example Configuration Files from Unit Tests
+=====================================================
+
+To exclude an example configuration file from unit tests, add the file path to the ``excluded_example_files`` list in ``tests/test_buildrunner_files.py``.

examples/build/basic/buildrunner.yaml

@@ -3,5 +3,5 @@ steps:
   simple-build-step:
     build:
       dockerfile: |
-        FROM busybox:latest
+        FROM alpine:latest
         RUN echo Hello World

examples/build/inject/buildrunner.yaml

@@ -8,7 +8,7 @@ steps:
         # The file /injectfile.txt will be injected into the build context
         examples/build/inject/injectfile.txt: /injectfile.txt
       dockerfile: |
-        FROM busybox
+        FROM alpine
         # Step 2: Copy the injected file into the image or use it in some other way in the build process
         COPY /injectfile.txt /tmp/
         RUN cat /tmp/injectfile.txt

examples/build/platform/buildrunner.yaml

@@ -5,6 +5,6 @@ steps:
   single-platform-build-step:
     build:
       dockerfile: |
-        FROM busybox:latest
+        FROM alpine:latest
         RUN echo Hello World
-      platform: linux/arm64/v8
+      platform: linux/amd64

examples/build/platforms/buildrunner.yaml

@@ -5,8 +5,8 @@ steps:
   multi-platform-build-step:
     build:
       dockerfile: |
-        FROM busybox:latest
-        RUN echo Hello World
+        FROM alpine:latest
+        LABEL custom_label="Buildrunner example label"
       platforms:
       - linux/amd64
-      - linux/arm64/v8
+      - linux/arm64

examples/run/basic/buildrunner.yaml

@@ -2,5 +2,5 @@
 steps:
   simple-run-step:
     run:
-      image: busybox:latest
+      image: alpine:latest
       cmd: echo Hello World

tests/test_buildrunner_files.py

@@ -119,11 +119,21 @@ def _get_test_runs(
 
 def _get_example_runs(test_dir: str) -> List[Tuple[str, str, Optional[List[str]], int]]:
     file_names = []
+
+    # Files that should be excluded from the example tests
+    excluded_example_files = [
+        "examples/build/import/buildrunner.yaml",
+    ]
+
     # Walk through the examples directory and find all files ending with buildrunner.yaml
     for root, _, files in os.walk(test_dir):
         for file in files:
             file_name = os.path.join(root, file)
-            if file_name.endswith("buildrunner.yaml"):
+            if file_name.endswith("buildrunner.yaml") and not [
+                excluded
+                for excluded in excluded_example_files
+                if file_name.endswith(excluded)
+            ]:
                 file_names.append(file_name)
 
     return [