feat(devcontainer): improve performance and reliability of devcontainer launch #472
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| #!/usr/bin/env bash | ||
|
Member
There was a problem hiding this comment. Can you set the SPDX and license header? |
||
| set -euo pipefail | ||
|
|
||
|
Comment on lines
+1
to
+3
There was a problem hiding this comment. This script doesn’t follow the structure used by the other devcontainer scripts in this repo (header comment + |
||
| # devcontainers copy your local gitconfig but do not parse conditional includes. | ||
| # This re-configures the devcontainer git identities based on the prior exported | ||
| # global and local git configurations *after* parsing host includes. See also: | ||
| # https://github.com/microsoft/vscode-remote-release/issues/2084#issuecomment-2289987894 | ||
| copy_user_gitconfig() { | ||
| for conf in .gitconfig.global .gitconfig.local; do | ||
| if [[ -f "$conf" ]]; then | ||
| echo "*** Parsing ${conf##.gitconfig.} Git configuration export" | ||
| while IFS='=' read -r key value; do | ||
| local key value | ||
| case "$key" in | ||
| user.name | user.email | user.signingkey | commit.gpgsign) | ||
| echo "Set Git config ${key}=${value}" | ||
| git config --global "$key" "$value" | ||
|
Comment on lines
+12
to
+17
There was a problem hiding this comment. Inside the |
||
| ;; | ||
| esac | ||
| done < "$conf" | ||
| rm -f "${conf}" | ||
| fi | ||
| done | ||
| } | ||
|
|
||
| # Main execution path | ||
|
|
||
| copy_user_gitconfig | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,10 +7,37 @@ | |
|
|
||
| set -euo pipefail | ||
|
|
||
| # Volume ownership is not set automatically due to a bug: | ||
| # https://github.com/microsoft/vscode-remote-release/issues/9931 | ||
| # | ||
| # IMPORTANT: workaround requires Docker base image to have password-less sudo. | ||
| fix_volume_ownership() { | ||
| local volume_path="$1" | ||
|
|
||
| if [[ ! -d "$volume_path" ]]; then | ||
| echo "ERROR: the volume path provided '$volume_path' does not exist." | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "Setting volume ownership for $volume_path" | ||
|
Comment on lines
+20
to
+22
There was a problem hiding this comment. The volume ownership workaround uses |
||
| sudo chown "$USER:$USER" "$volume_path" | ||
| } | ||
|
|
||
| fix_volume_ownerships() { | ||
| echo "Applying volume ownership workaround (see microsoft/vscode-remote-release#9931)..." | ||
| fix_volume_ownership "/home/${USER}/.config" | ||
| fix_volume_ownership "/workspace/node_modules" | ||
| } | ||
|
|
||
| npm_install() { | ||
| echo "Installing NPM dependencies..." | ||
|
Comment on lines
+30
to
33
There was a problem hiding this comment. This script switches from |
||
| npm ci | ||
| echo "NPM dependencies installed successfully" | ||
| } | ||
|
|
||
| main() { | ||
| fix_volume_ownerships | ||
| npm_install | ||
| } | ||
|
|
||
| main "$@" | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| **/.git/ | ||
| **/node_modules/ |
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,8 +1,16 @@ | ||||||||||||||||||
| # Set the default behavior, in case core.autocrlf has not been set. | ||||||||||||||||||
| * text=auto | ||||||||||||||||||
|
|
||||||||||||||||||
| # Declare files that must have specific line endings on checkout. | ||||||||||||||||||
| ## Windows scripts - must be CRLF | ||||||||||||||||||
| *.ps1 text eol=crlf | ||||||||||||||||||
| *.bat text eol=crlf | ||||||||||||||||||
| *.cmd text eol=crlf | ||||||||||||||||||
|
|
||||||||||||||||||
|
Comment on lines
+6
to
+9
There was a problem hiding this comment. Setting
Suggested change
|
||||||||||||||||||
| ## Linux scripts - must be LF | ||||||||||||||||||
| *.sh text eol=lf | ||||||||||||||||||
| *.Dockerfile text eol=lf | ||||||||||||||||||
| Dockerfile* text eol=lf | ||||||||||||||||||
|
|
||||||||||||||||||
| # Denote all files that are truly binary and should not be modified. | ||||||||||||||||||
| *.docx binary | ||||||||||||||||||
|
|
||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
workspaceMountincludes literal quotes around thesource=value. Docker’s--mountparser treats those quotes as part of the path, which can cause the bind mount to fail and prevent the devcontainer from starting. Consider removing the embedded quotes and relying on the mount string being passed as a single argument (spaces in paths are already handled).