Changes following review comments.

Signed-off-by: davem-bis <68955845+davem-bis@users.noreply.github.com>

Author: davem-bis

.devcontainer/post-create-command.sh

@@ -2,7 +2,13 @@
 
 # This script is intended to be run by an Ubuntu dev container
 
+# Exit immediately if any command returns a non-zero code
+set -e
+
 # Install OS-level dependencies
+
+# Note that msodbcsql18 install requires the Microsoft APT repo to be available to this script. If this script is used
+# in conjunction with a container image from the Microsoft container registry this should already be the case.
 ALL_DEPENDENCIES="libpq-dev netcat-traditional unixodbc-dev default-jdk msodbcsql18"
 
 sudo apt-get clean && sudo apt-get -y update && sudo ACCEPT_EULA='Y' apt-get -y install $ALL_DEPENDENCIES

docs/development.md

@@ -15,15 +15,17 @@ Before you begin, ensure you have the following installed on your machine. Exact
 
 The development environment of SQLMesh depends both on:
 
-* Python functionality (e.g. `SIGUSR1`) that is only available on UNIX systems, and;
-* Symbolic links in the repository which, whilst available on Windows, typically require additional permissions for the process running git.
+* Symbolic links in the repository which, whilst available on Windows, typically require additional permissions for the process running git, and;
+* Some Python functionality (e.g. `SIGUSR1`) that is only available on UNIX systems. Whilst this functionality is gated so shouldn't error on Windows, the development container enables its use.
 
 For the Python functionality, a dev container is provided to develop against Ubuntu 24 with Python 3.12.
 
 For symbolic links, you must ensure that when checking out the repository:
 
-- The git configuration `core.symlinks` is set to `true`
-- The process that git runs as is permitted to create symbolic links. This can typically be done by running git as an administrator, or enabling [developer mode on Windows](https://learn.microsoft.com/en-us/windows/advanced-settings/developer-mode).
+* The git configuration `core.symlinks` is set to `true` (this also needs to be done before bind mount, i.e. when the dev container is started)
+* The process that git runs as is permitted to create symbolic links. This can typically be done by running git as an administrator, or enabling [developer mode on Windows](https://learn.microsoft.com/en-us/windows/advanced-settings/developer-mode).
+
+Dev containers are supported by [a number of IDEs](https://containers.dev/supporting.html). For developers using VSCode,  [Microsoft has a tutorial on how to use dev containers](https://code.visualstudio.com/docs/devcontainers/tutorial).
 
 ## Virtual environment setup