Add a default build script

.github/workflows/build.yml

@@ -69,12 +69,7 @@ jobs:
           fi
 
       - name: Configure and build
-        run: |
-          cmake --version
-          bun install
-          bun run codegen
-          bun run meson-setup.clang-release
-          meson compile -C build/ vs:executable
+        run: scripts/build-default.sh
       - name: Archive production artifacts
         uses: actions/upload-artifact@v4
         with:
@@ -107,14 +102,7 @@ jobs:
           echo "PATH=$PATH" >> $GITHUB_ENV
 
       - name: Configure and build
-        run: |
-          cmake --version
-          bun install
-          bun run codegen
-          meson setup -Dforce_x11_backend=true --reconfigure build/ --buildtype=release --native-file toolchains/flatpak.ini
-          # Unclear fix to be investigated
-          rm subprojects/libtcc/VERSION
-          meson compile -C build/ vs:executable
+        run: scripts/build-default.sh
       - name: Archive production artifacts
         uses: actions/upload-artifact@v4
         with:

.github/workflows/docker-test.yml

@@ -66,7 +66,10 @@ jobs:
       - name: Run commands in Docker container
         run: |
           export HOSTUID=$(id -u) HOSTGID=$(id -g)
-          docker compose -f docker/docker-compose.yml run --rm  dev
+          docker compose -f docker/docker-compose.yml up -d dev
+          docker exec --user builder vs-fltk-env \
+            bash -l -c 'cd $WORKSPACE && scripts/build-default.sh'
+          docker container stop vs-fltk-env
+          docker container rm vs-fltk-env
         env:
-          ENTRYPOINT: /entry-build.sh
-          WORKSPACE: ${{ github.workspace }}/vs-workspace
+          WORKSPACE: /vs-workspace

docker/README.md

@@ -18,28 +18,21 @@ Replace the values for `HOSTUID` and `HOSTGID` with your system `uid` and `gid`.
 Then, from the source root, to enter the build environment:
 
 ```sh
-docker-compose -f docker/docker-compose.yml run --rm  dev
+docker compose -f docker/docker-compose.yml run --rm  dev
 ```
 
 From there, you can run the commands to build the app. You can use your
 regular IDE to make changes, and then test them by building within the
-container.
-
-To start the container and build the app non-interactively:
+container. A convenience script is available:
 
 ```sh
-export ENTRYPOINT=/entry-build.sh
+scripts/build-default
 ```
 
-And use the same command as shown above.
-
-Remember to unset `ENTRYPOINT` when you wish to start the container with only
-a prompt.
-
-All of the above methods will mount your current directory as _/vs-workspace_
-inside the container. Your username will be _builder_. By default, you will
-not have root privileges (which are not necessary to build and test). However,
-you can use `sudo` if you need to run `apt` or any other commands that require
+When starting the container, your current directory will be mounted at
+_/vs-workspace_. Your username will be _builder_. By default, you will not
+have root privileges (which are not necessary to build and test). However, you
+can use `sudo` if you need to run `apt` or any other commands that require
 root access.
 
 ## Notes
@@ -112,7 +105,7 @@ necessary devices. Here's a general guide:
 3. **Run the container with access to the display:**
    When starting the container, pass the display environment variable
    (`$DISPLAY`) and mount the X11 socket. Instead of *dev" for the last
-   argument of `docker-compose` (see above), use *xgui\*, which essentially
+   argument of `docker-compose` (see above), use *x11-dev\*, which essentially
    adds these three arguments (through the compose configuration):
 
    ```sh

docker/docker-compose.yml

@@ -2,7 +2,7 @@ services:
   dev:
     image: "${IMAGE:-ghcr.io/karurochori/vs-fltk:build-env}"
     container_name: "${VS_NAME:-vs-fltk-env}"
-    entrypoint: "${ENTRYPOINT:-/entry-default.sh}"
+    entrypoint: "${ENTRYPOINT:-/entrypoint.sh}"
 
     # Only variables used within the container should be here
     environment:
@@ -14,9 +14,8 @@ services:
 
     volumes:
       - ${PWD}:${WORKSPACE}
-      # Mount the entrypoint scripts inside the container
-      - ${PWD}/docker/entry-build.sh:/entry-build.sh
-      - ${PWD}/docker/entry-default.sh:/entry-default.sh
+      # Mount the script inside the container
+      - ${PWD}/docker/entrypoint.sh:/entrypoint.sh
     working_dir: ${WORKSPACE}
     stdin_open: true # Allows interactive mode
     tty: true # Allocate a pseudo-TTY

docker/entrypoint.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+# entrypoint.sh
+
+set -e
+
+if [ -z "$HOSTUID" ]; then
+  echo "HOSTUID is not set."
+  exit 1
+fi
+
+if [ -z "$HOSTGID" ]; then
+  echo "HOSTGID is not set."
+  exit 1
+fi
+
+usermod -u $HOSTUID builder
+groupmod -g $HOSTGID builder
+
+# If -l, --login is used here, the variables defined in
+# docker-compose.yml do not get exported
+su builder

scripts/build-default.sh

@@ -0,0 +1,25 @@
+#!/bin/sh
+# This file is part of vs-fltk
+# License: https://github.com/KaruroChori/vs-fltk/blob/master/LICENCE.md
+
+set -e
+
+if [ ! -f "src/app/main.cpp" ]; then
+  echo "This script must be run from the source root."
+  exit 1
+fi
+
+set -v
+
+bun install
+bun run codegen
+
+if [ "$(uname)" != "Darwin" ]; then
+  bun run meson-setup.clang-release
+else
+  meson setup -Dforce_x11_backend=true --reconfigure build --buildtype=release --native-file toolchains/flatpak.ini
+  # Unclear fix to be investigated
+  rm subprojects/libtcc/VERSION
+fi
+
+meson compile -C build vs:executable