initial GitHub Codespace support

Author: joonas-fi

misc/turbobob-codespace/Dockerfile

@@ -0,0 +1,18 @@
+FROM alpine:latest AS builder
+
+RUN apk add --no-cache curl
+
+RUN curl --fail --location --no-progress-meter --output /usr/local/bin/bob https://function61.com/go/turbobob-latest-stable-linux-amd64 && chmod +x /usr/local/bin/bob
+
+
+FROM alpine:latest
+
+# git = used by GitHub codespaces
+# docker-cli = needed by Bob to launch sibling build containers from this "main container"
+RUN apk add --no-cache git docker-cli
+
+COPY --from=builder /usr/local/bin/bob /usr/local/bin/bob
+
+COPY init-bob-devcontainer.sh /usr/bin/init-bob-devcontainer.sh
+
+COPY vscode-resources/launch.json vscode-resources/tasks.json /

misc/turbobob-codespace/README.md

@@ -0,0 +1,97 @@
+turbobob-codespace
+==================
+
+Produces a [dev container](https://containers.dev/) specifically intended to enable integrating a repo with
+[GitHub Codespaces](https://github.com/features/codespaces).
+
+Goals
+
+- Integrate as many low-hanging fruit features as possible from Turbo Bob with GitHub Codespaces with minimal changes to concrete repos.
+
+Non-goals:
+
+- Work as a standalone dev container outside of GitHub Codespaces context.
+
+
+Architecture
+------------
+
+```mermaid
+flowchart TD
+    subgraph "Codespaces VM"
+        dockerd
+        ghbootstrap[GitHub Codespaces bootstrap]
+
+        user
+
+        subgraph "Workspace files"
+            vscodeconf[VSCode conf]
+
+            buildtask[task: build = $ bob build]
+        end
+    end
+
+    subgraph "container: turbobob-codespace"
+        initbobdevcontainer[init-bob-devcontainer.sh]
+
+        bobbuild[$ bob build]
+    end
+
+    subgraph "Bob-managed containers"
+        subgraph "buildkit-golang"
+            gobuild[$ go build]
+        end
+    end
+
+ghbootstrap -- launch container, invoke --> initbobdevcontainer
+
+initbobdevcontainer -- writes dynamically --> vscodeconf
+
+vscodeconf -- defines --> buildtask
+
+bobbuild -. launch container .-> dockerd
+user -- build --> buildtask -- invokes --> bobbuild -- run actual build --> gobuild
+
+```
+
+
+Use from concrete repo
+----------------------
+
+Define `.devcontainer/devcontainer.json`:
+
+```json
+{
+  "$schema": "https://raw.githubusercontent.com/devcontainers/spec/main/schemas/devContainer.schema.json",
+  "name": "Turbo Bob",
+  "image": "ghcr.io/function61/turbobob-codespace:latest",
+  // needed for at least mount command done by `init-bob-devcontainer.sh`
+  "privileged": true,
+  // for some reason the mount args given here do not work if given in the `mounts` field
+  "runArgs": [
+     // to be able to copy Bob to host-side
+     "--mount=type=bind,source=/,destination=/host"
+   ],
+  // prepares the container so it can succesfully launch sibling containers from Bob.
+  // think of this as adapter for Bob running inside devcontainer.
+  "onCreateCommand": ["/usr/bin/init-bob-devcontainer.sh"],
+  "mounts": [
+    "type=bind,source=/var/run/docker.sock,destination=/var/run/docker.sock"
+  ]
+}
+```
+
+
+Build
+-----
+
+```shell
+docker buildx build -t ghcr.io/function61/turbobob-codespace:latest . --push
+```
+
+Resources
+---------
+
+- https://github.com/qdm12/godevcontainer/blob/master/.devcontainer/devcontainer.json
+- https://github.com/devcontainers/images/blob/main/src/go/.devcontainer/devcontainer.json
+- https://github.com/qdm12/godevcontainer/blob/master/.devcontainer/devcontainer.json

misc/turbobob-codespace/init-bob-devcontainer.sh

@@ -0,0 +1,11 @@
+#!/bin/sh -eu
+
+# Bob maps this from host-side to new containers it launches so we must copy it to host
+cp /usr/local/bin/bob /host/usr/local/bin/bob
+
+# Bob integration to VSCode's launch config
+mkdir .vscode
+cp /launch.json /tasks.json .vscode/
+
+# Bob writes stuff under /tmp which it then maps to inside Bob-spawned build containers
+mount --bind /host/tmp /tmp

misc/turbobob-codespace/vscode-resources/launch.json

@@ -0,0 +1,17 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Build (fast)",
+            "command": "bob build --uncommitted --fast",
+            "request": "launch",
+            "type": "node-terminal"
+        },
+        {
+            "name": "Build",
+            "command": "bob build --uncommitted",
+            "request": "launch",
+            "type": "node-terminal"
+        }
+    ]
+}

misc/turbobob-codespace/vscode-resources/tasks.json

@@ -0,0 +1,15 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Build",
+            "type": "shell",
+            "command": "bob build --uncommitted --fast",
+            "problemMatcher": [],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        }
+    ]
+}