add demo with github pages (refs #41)

Author: mborne

.ci/build-demo.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+PROJECT_DIR=$(dirname "$SCRIPT_DIR")
+
+if [ -z "$SATIS_GITHUB_TOKEN" ];
+then
+    echo "SATIS_GITHUB_TOKEN required"
+    exit
+fi
+
+cd "$PROJECT_DIR"
+
+# generate the satis config file (satis.json) 
+bin/satis-gitlab gitlab-to-config \
+    --template ".ci/template.json" \
+    https://github.com $SATIS_GITHUB_TOKEN \
+    --users=mborne \
+    --ignore="(^mborne\\/php-helloworld)" \
+    --output satis.json
+
+# build public directory
+bin/satis-gitlab build --skip-errors satis.json public

.ci/template.json

@@ -0,0 +1,13 @@
+{
+    "name": "mborne/demo-satis-gitlab",
+    "homepage": "https://mborne.github.io/satis-gitlab/",
+    "repositories": [
+        {
+            "type": "composer",
+            "url": "https://packagist.org"
+        }
+    ],
+    "require": [],
+    "require-dependencies": false,
+    "require-dev-dependencies": false
+}

.github/workflows/demo-pages.yml

@@ -0,0 +1,64 @@
+name: Build and publish demo on GitHub pages
+
+on:
+  push:
+    branches: [ "master" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: "Setup PHP 8.3"
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: 8.3
+
+    - name: Validate composer.json
+      run: composer validate --strict
+
+    - name: Cache Composer packages
+      id: composer-cache
+      uses: actions/cache@v3
+      with:
+        path: vendor
+        key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-php-
+
+    - name: Install dependencies
+      run: composer install --prefer-dist --no-progress
+
+    - name: Build demo
+      run: bash .ci/build-demo.sh
+      env:
+        SATIS_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Upload static files from public as artifact
+      id: deployment
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: public/
+
+  # Deploy pages
+  deploy:
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Specify runner + deployment step
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -3,6 +3,7 @@
 /satis.json
 /web/
 /output/
+/public/
 
 /composer.phar
 /.phpunit.result.cache