]> git.proxmox.com Git - mirror_edk2.git/commitdiff
.devcontainer/devcontainer.json: Add devcontainer file
authorMichael Kubacki <michael.kubacki@microsoft.com>
Fri, 20 Jan 2023 17:07:22 +0000 (12:07 -0500)
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Tue, 14 Feb 2023 01:28:13 +0000 (01:28 +0000)
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@apple.com>
Cc: Chris Fernald <chris.fernald@outlook.com>
Cc: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Oliver Steffen <osteffen@redhat.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
.devcontainer/devcontainer.json [new file with mode: 0644]
Maintainers.txt

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