Meta: Add devcontainer configuration for use with Github Codespaces

This configuration allows developing serenity and ladybird in github codespaces. It should also help anyone who wants to use a devcontainer locally.
Author: https://github.com/ADKaster Commit: https://github.com/SerenityOS/serenity/commit/21f500937b Pull-request: https://github.com/SerenityOS/serenity/pull/16042 Reviewed-by: https://github.com/BertalanD Reviewed-by: https://github.com/linusg
2026-04-26 01:35:08 +02:00 · 2022-11-12 21:30:10 +00:00 · 2024-07-17 04:04:29 +09:00
parent 9bf2a7c7e5
commit 21f500937b
3 changed files with 130 additions and 0 deletions
--- a/.devcontainer/devcontainer.json
+++ b/.devcontainer/devcontainer.json
@@ -0,0 +1,40 @@
+{
+    "name": "Ubuntu",
+    "image": "mcr.microsoft.com/devcontainers/base:jammy",
+
+    // Features to add to the dev container. More info: https://containers.dev/implementors/features.
+    "features": {
+        "ghcr.io/devcontainers/features/github-cli:1": {},
+        "ghcr.io/devcontainers-contrib/features/pre-commit:1": {},
+        "./serenity": {
+            "llvm_version": 15,
+            "enable_ladybird": true,
+            "enable_serenity": true
+        },
+        "ghcr.io/devcontainers/features/desktop-lite": {
+            "password": "vscode",
+            "webPort": "6080",
+            "vncPort": "5901"
+        }
+    },
+
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    "forwardPorts": [6080, 5901],
+    "portsAttributes": {
+        "5901": {
+            "label": "VNC"
+        },
+        "6080": {
+            "label": "Web VNC"
+        }
+    },
+
+    // Use 'postCreateCommand' to run commands after the container is created.
+    "postCreateCommand": "pre-commit install; pre-commit install --hook-type commit-msg"
+
+    // Configure tool-specific properties.
+    // "customizations": {},
+
+    // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+    // "remoteUser": "root",
+}