From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from linux.microsoft.com (linux.microsoft.com [13.77.154.182]) by mx.groups.io with SMTP id smtpd.web11.88360.1674251841182890801 for ; Fri, 20 Jan 2023 13:57:21 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@linux.microsoft.com header.s=default header.b=bzVtMJIb; spf=pass (domain: linux.microsoft.com, ip: 13.77.154.182, mailfrom: mikuback@linux.microsoft.com) Received: from [192.168.4.22] (unknown [47.201.8.94]) by linux.microsoft.com (Postfix) with ESMTPSA id E743D20E0A28; Fri, 20 Jan 2023 13:57:19 -0800 (PST) DKIM-Filter: OpenDKIM Filter v2.11.0 linux.microsoft.com E743D20E0A28 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.microsoft.com; s=default; t=1674251840; bh=qzS+bBFAZcZ8aBfyDdE+6LCeG3lXbA8UdELDZbxLi/g=; h=Date:Subject:To:Cc:References:From:In-Reply-To:From; b=bzVtMJIbRiPtifC1tz+N76B+VTaDoXRvDcTCBCtNk9bGulGuxRVhze0bc/CwjXe8K 9gC1JOf7WebEysodfKQJ0LcdFn6Su5nL8fJNDwleHSS6DtOhW71dHRhaKItDVC5d0F Z9A9IidAZ/vCga03Zuim7IVtT6TTwt/Io5sLWaxI= Message-ID: Date: Fri, 20 Jan 2023 16:57:18 -0500 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (Windows NT 6.2; Win64; x64; rv:91.0) Gecko/20100101 Thunderbird/91.13.1 Subject: Re: [edk2-devel] [PATCH v1 1/1] .devcontainer/devcontainer.json: Add devcontainer file To: devel@edk2.groups.io, rebecca@bsdio.com Cc: Andrew Fish , Chris Fernald , Leif Lindholm , Michael D Kinney , Oliver Steffen References: <20230120205157.167-1-mikuback@linux.microsoft.com> <4be046eb-ea12-2e0c-2bd8-5b735c5028b1@bsdio.com> From: "Michael Kubacki" In-Reply-To: <4be046eb-ea12-2e0c-2bd8-5b735c5028b1@bsdio.com> Content-Language: en-US Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit I think that's a good idea. edk2-pytool-extensions has a .vscode/settings.json file that has been useful for local python linting and testing that helps catch issues before CI. For example: https://github.com/tianocore/edk2-pytool-extensions/blob/master/.vscode/settings.json On 1/20/2023 4:22 PM, Rebecca Cran wrote: > Related to this, I've been wondering if we might want to commit a .vscode directory with project configuration file(s)? > > Also perhaps a .editorconfig file? > > -- > > Rebecca Cran > > > On 1/20/23 13:51, Michael Kubacki wrote: >> From: Michael Kubacki >> >> 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 >> Cc: Chris Fernald >> Cc: Leif Lindholm >> Cc: Michael D Kinney >> Cc: Oliver Steffen >> Signed-off-by: Michael Kubacki >> --- >> .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 [makubacki] >> R: Michael D Kinney [mdkinney] >> R: Liming Gao [lgao4] >> >> +.devcontainer/ >> +F: .devcontainer/ >> +M: Michael Kubacki [makubacki] >> +R: Chris Fernald [cfernald] >> + >> .github/ >> F: .github/ >> M: Sean Brogan [spbrogan] >