ci: run examples (#327)

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

.github/workflows/php.yml

@@ -398,3 +398,37 @@ jobs:
           src
           github
           phpmd.xml
+  examples:
+    name: Examples
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - name: Checkout
+        # see https://github.com/actions/checkout
+        uses: actions/checkout@v3
+      - name: Setup PHP
+        # see https://github.com/shivammathur/setup-php
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ env.PHP_VERSION_LATEST }}
+          tools: composer:v2
+          coverage: none
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+      - name: Cache dependencies
+        if: ${{ steps.composer-cache.outputs.dir }}
+        # see https://github.com/actions/cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: composer-${{ github.job }}-${{ runner.os }}-${{ hashFiles('composer.*', 'tools/phpmd/composer.*') }}
+          restore-keys: |
+            composer-${{ github.job }}-${{ runner.os }}-
+      - name: Install dependencies
+        run: composer install --no-dev --prefer-dist --no-interaction --no-progress
+      - name: run all examples
+        run: >
+          find examples -type f -name '*.php' -print0
+          | xargs -0 -L1 -t
+          php -f

examples/README.md

@@ -0,0 +1,7 @@
+# Examples
+
+* [Build & Serialize](build_and_serialize.php)
+
+----
+
+see examples how to use data models in the [bom model data provider](../tests/_data/BomModelProvider.php)