public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
* [PATCH v1 1/1] .devcontainer/devcontainer.json: Add devcontainer file
@ 2023-01-20 20:51 Michael Kubacki
  2023-01-20 21:22 ` [edk2-devel] " Rebecca Cran
  0 siblings, 1 reply; 14+ messages in thread
From: Michael Kubacki @ 2023-01-20 20:51 UTC (permalink / raw)
  To: devel
  Cc: Andrew Fish, Chris Fernald, Leif Lindholm, Michael D Kinney,
	Oliver Steffen

From: Michael Kubacki <michael.kubacki@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@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>
---
 .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@linux.microsoft.com> [makubacki]
 R: Michael D Kinney <michael.d.kinney@intel.com> [mdkinney]
 R: Liming Gao <gaoliming@byosoft.com.cn> [lgao4]
 
+.devcontainer/
+F: .devcontainer/
+M: Michael Kubacki <mikuback@linux.microsoft.com> [makubacki]
+R: Chris Fernald <chris.fernald@outlook.com> [cfernald]
+
 .github/
 F: .github/
 M: Sean Brogan <sean.brogan@microsoft.com> [spbrogan]
-- 
2.28.0.windows.1


^ permalink raw reply related	[flat|nested] 14+ messages in thread
[parent not found: <173C1FA3C96CC3CD.14781@groups.io>]

end of thread, other threads:[~2023-02-14  1:29 UTC | newest]

Thread overview: 14+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-01-20 20:51 [PATCH v1 1/1] .devcontainer/devcontainer.json: Add devcontainer file Michael Kubacki
2023-01-20 21:22 ` [edk2-devel] " Rebecca Cran
2023-01-20 21:57   ` Michael Kubacki
2023-01-23  9:23   ` Oliver Steffen
2023-01-23 10:46     ` Ard Biesheuvel
     [not found] <173C1FA3C96CC3CD.14781@groups.io>
2023-01-20 20:54 ` Michael Kubacki
2023-01-24  9:52   ` Oliver Steffen
2023-01-26 14:44 ` Michael Kubacki
     [not found] ` <173DE310BC2140E3.21537@groups.io>
2023-02-05 18:34   ` Michael Kubacki
2023-02-05 19:54     ` Michael D Kinney
2023-02-08  3:49     ` Michael Kubacki
2023-02-10  5:01       ` Michael D Kinney
2023-02-13 14:13         ` Michael Kubacki
2023-02-14  1:28           ` Michael D Kinney

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox