Skip to content

Latest commit

 

History

History

turbobob-codespace

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
vscode-resources
vscode-resources
 
 
Dockerfile
Dockerfile
 
 
README.md
README.md
 
 
init-bob-devcontainer.sh
init-bob-devcontainer.sh
 
 

README.md

turbobob-codespace

Produces a dev container specifically intended to enable integrating a repo with GitHub 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

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
Loading

Use from concrete repo

Define .devcontainer/devcontainer.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

docker buildx build -t ghcr.io/function61/turbobob-codespace:latest . --push

Resources