[edk2-devel] [PATCH v1 1/1] .devcontainer/devcontainer.json: Add devcontainer file

[Michael Kubacki]

From: Michael Kubacki <michael.kubacki at microsoft.com>

Tianocore maintains container images in the tianocore/containers repo
and stores container images within the GitHub container registry.

https://github.com/tianocore/containers

This change adds a devcontainer.json file to the edk2 repo. This
file's metadata and settings to configurate a development container
for a given well-defined tool and runtime stack.

More information about the devcontainer.json file is available here:
https://containers.dev/implementors/json_reference/

This file is recognized by popular tools such as GitHub Codespaces
and VS Code. In VS Code in particular, it makes it much easier for
a user to be aware a dev container exists (via UI notifications)
and to load the container.

A minimal number of VS Code extensions are specified that are useful
for edk2 development or to assist in complying with CI checks in
place in edk2.

Cc: Andrew Fish <afish at apple.com>
Cc: Chris Fernald <chris.fernald at outlook.com>
Cc: Leif Lindholm <quic_llindhol at quicinc.com>
Cc: Michael D Kinney <michael.d.kinney at intel.com>
Cc: Oliver Steffen <osteffen at redhat.com>
Signed-off-by: Michael Kubacki <michael.kubacki at microsoft.com>
---
 .devcontainer/devcontainer.json | 16 ++++++++++++++++
 Maintainers.txt                 |  5 +++++
 2 files changed, 21 insertions(+)

diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
new file mode 100644
index 000000000000..592bb8cf6626
--- /dev/null
+++ b/.devcontainer/devcontainer.json
@@ -0,0 +1,16 @@
+{
+  "image": "ghcr.io/tianocore/containers/fedora-35-dev:latest",
+  "postCreateCommand": "git config --global --add safe.directory * && pip install --upgrade -r pip-requirements.txt",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "DavidAnson.vscode-markdownlint",
+        "ms-azuretools.vscode-docker",
+        "ms-vscode-remote.remote-containers",
+        "ms-vscode.cpptools",
+        "walonli.edk2-vscode",
+        "zachflower.uncrustify"
+      ]
+    }
+  }
+}
diff --git a/Maintainers.txt b/Maintainers.txt
index 68f603b48398..4aa7973d5156 100644
--- a/Maintainers.txt
+++ b/Maintainers.txt
@@ -117,6 +117,11 @@ M: Michael Kubacki <mikuback at linux.microsoft.com> [makubacki]
 R: Michael D Kinney <michael.d.kinney at intel.com> [mdkinney]
 R: Liming Gao <gaoliming at byosoft.com.cn> [lgao4]
 
+.devcontainer/
+F: .devcontainer/
+M: Michael Kubacki <mikuback at linux.microsoft.com> [makubacki]
+R: Chris Fernald <chris.fernald at outlook.com> [cfernald]
+
 .github/
 F: .github/
 M: Sean Brogan <sean.brogan at microsoft.com> [spbrogan]
-- 
2.28.0.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#98940): https://edk2.groups.io/g/devel/message/98940
Mute This Topic: https://groups.io/mt/96409896/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-