Add docker-compose example (closes #14)

Author: andy5995

.env

@@ -0,0 +1,15 @@
+# Your numeric uid and gid
+HOSTUID=
+HOSTGID=
+
+# Default architecture
+PLATFORM="linux/amd64"
+
+# Absolute or relative path to your AppImage build script
+SCRIPT="/workspace/path/to/script"
+
+# When run from the root of your project directory, this will be
+# the location in the container
+WORKSPACE="/workspace"
+
+ENTRYPOINT="/entrypoint.sh"

.github/workflows/test.yml

@@ -9,11 +9,13 @@ on:
     branches: trunk
     paths:
     - 'action.yml'
+    - 'docker-compose.yml'
     - '**test.yml'
   pull_request:
     branches: trunk
     paths:
     - 'action.yml'
+    - 'docker-compose.yml'
     - '**test.yml'
 
 env:
@@ -44,16 +46,25 @@ jobs:
             echo "VERSION=${{ github.sha }}" >> $GITHUB_ENV
           fi
 
+      - name: Install docker-compose
+        run: |
+          #sudo apt update
+          #sudo apt upgrade -y
+          sudo apt install -y docker-compose
+
+      - name: Checkout rmw
+        uses: actions/checkout@v4
+        with:
+          path: _linuxdeploy_test
+
       - name: Build AppImage
         run: |
-          docker run -t \
-            --rm \
-            --platform=${{ matrix.platform }} \
-            -e HOSTUID=$(id -u) \
-            -e VERSION \
-            -v $GITHUB_WORKSPACE:/workspace \
-            -w /workspace \
-            andy5995/linuxdeploy:v2-focal packaging/appimage/pre-appimage.sh
+          export HOSTUID=$(id -u) HOSTGID=$(id -g)
+          docker-compose -f _linuxdeploy_test/docker-compose.yml run --rm build
+        env:
+          SCRIPT: 'packaging/appimage/pre-appimage.sh'
+          VERSION: $VERSION
+          PLATFORM: ${{ matrix.platform }}
 
       - name: Create sha256sum
         run: |

README.md

@@ -19,13 +19,7 @@ version Ubuntu.
 
 ## Example usage
 
-    docker run -t \
-    --rm \
-    -e HOSTUID=$(id -u) \
-    -e VERSION=test \
-    -v $PWD:/workspace \
-    -w /workspace \
-    andy5995/linuxdeploy:v2-focal packaging/appimage/pre-appimage.sh
+    docker-compose run --rm build
 
 This is meant to be run from the source root of your project. Using the
 command above, your current directory will be mounted in the container at

docker-compose.yml

@@ -0,0 +1,13 @@
+services:
+  build:
+    environment:
+      HOSTUID: ${HOSTUID}
+      HOSTGID: ${HOSTGID}
+      VERSION: ${VERSION}
+    image: andy5995/linuxdeploy:v2-focal
+    entrypoint: $ENTRYPOINT
+    volumes:
+      - $PWD:$WORKSPACE
+    working_dir: $WORKSPACE
+    command: $SCRIPT
+    restart: "no"

entrypoint.sh

@@ -25,6 +25,7 @@ if [ -z "$1" ]; then
 fi
 
 usermod -u "$HOSTUID" builder
+groupmod -g "$HOSTGID" builder
 chown -R "$HOSTUID:$HOSTGID" /home/builder
 
 # The docs state to use '-w /workdir when running the container, but switching